List Users

Copied

                https://api.ocamba.com/v1/hood/users

Returns a list of Users

query Parameters

Name

Description

fieldsstring

Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.

Example: fields=field1,field2,field3

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

Response status codes

200 - OK

Name

Description

items[ user ]

An array of all created items.

User

Name

Description

ad_clicksstring

Number of times user has clicked.

Example: 10

ad_conversionsstring

Number of times user has made a conversion.

Example: 14

ad_impressionsstring

Number of times user has viewed an ad.

Example: 1063

ad_incomestring

The gain derived from any dimension you requested.

Example: 2374.67

ad_last_clickeddateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

ad_last_impressiondateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

ad_last_serveddateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

ad_servedstring

Number of times user has received an ad.

Example: 89

ad_spam_clicksstring

Number of times user has made a spam click.

Example: 0

ad_spam_impressionsstring

Number of times user views an spam impression.

Example: 0

app_namestring

The name of the application.

Example: delsystems.net

asnstring

The Autonomous System Number unique identifier.

Example: 2510

browser_idinteger

A unique browser identifier.

Example: 12

browser_namestring

The browser name.

Example: Chrome

browser_versionstring

The browser version.

Example: 74

citystring

A unique city identifier.

Example: 2657896

city_namestring

The city name.

Example: New York

client_idstring

A unique identifier generated by the Ocamba platform.

Example: 1094

commentstring

Comment added to user

Example: This is Ocamba User

company_idstring

The ID of the Company, generated by the Ocamba.

Example: 1000000

conn_typestring

A unique connection type identifier.

Example: 2

conn_type_namestring

The connection type name.

Example: cellular

conversion_scorestring

A metric indicating the effectiveness of campaigns in driving desired user actions. Higher scores reflect better conversion performance and are based on tracked events and user behavior.

Example: 15

coststring

The cost incurred in the performance of the requested dimension.

Example: 0.33

country_codestring

The two letter country code.

Example: RS

device_idinteger

A unique device identifier.

Example: 13

device_namestring

The device name.

Example: Blackberry

emailstring

Email of user.

Example: [email protected]

email_statusstring

User email status, 1 (has email set) or 0 (hasn't email set).

Example: 1

email_subscription_timedateTime

Timezone: GMT.

Example: 2022-03-22 10:17:33

extraobject

Extra object.

Example: { "clicker":"1" }

first_session_datedate

Timezone: GMT.

Example: 2022-01-13

ispstring

The Internet Service Provider.

Example: Fujitsu

last_clickeddateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

last_session_timedateTime

Timezone: GMT.

Example: 2022-01-13 16:33:17

mobile_phone_numberstring

Mobile phone number in E.164 standard

Example: +1441234567

os_idstring

A unique operating system identifier.

Example: 4

os_namestring

The operating system name.

Example: iOS

os_versionstring

The operating system version.

Example: 10

push_clicksstring

Number of times user clicked on push notification.

Example: 122

push_credentialsobject

Credential object.

Example: { "endpoint":"https://fcm.googleapis.com/fcm/send/example" }

push_last_clickeddateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

push_last_toucheddateTime

Timezone: GMT.

Example: 2022-03-20 20:45:11

push_statusstring

User status, user can be 0 (inactive), 1 (subscribed) or 2 (unsubscribed).

Example: 1

push_status_strstring

User status, user can be inactive, subscribed or unsubscribed.

Example: subscribed

push_subscription_timedateTime

Timezone: GMT.

Example: 2022-03-22 10:17:33

push_unsubscription_timedateTime

Timezone: GMT.

Example: 2022-02-17 23:11:00

push_wokenupstring

Number of times user has received a notification.

Example: 122

regionstring

A unique region identifier.

Example: 5855797

region_namestring

The region name.

Example: Hawaii

remote_user_idstring

Type here

retargetingobject

Retargeting object.

Example: { "retargeting":"test", "test":"value" }

sms_statusstring

User sms status, 1 (has mobile phone number) or 0 (hasn't mobile_phone_number).

Example: 1

sms_subscription_timedateTime

Timezone: GMT.

Example: 2022-03-22 10:17:33

tag_idstring

The ID of the tag, generated by the Ocamba.

Example: 1000

tag_namestring

The name of the tag, provided by the client.

Example: Demo Tag

tag_typestring

The type of the tag. Currently only web applications are supported.

Example: web

Possible values: web

timezonestring

The user timezone.

Example: Europe/Istanbul

total_goalsstring

Type here

Example: 163

total_pageviewsstring

Number of pageviews that user has made.

Example: 163

total_sessionsstring

Number of sessions that user has made.

Example: 10

traffic_source_typestring

user_langstring

The two letter language code.

Example: en

utm_campaignstring

Urchin Tracking Module campaign, used to identify a strategic campaign.

Example: push_campaign

utm_contentstring

Urchin Tracking Module content, used to differentiate ads or links that point to the same URL.

Example: logolink

utm_mediumstring

Urchin Tracking Module medium, used to identify a medium.

Example: organic

utm_sourcestring

Urchin Tracking Module source, used to identify a search engine, social media, newsletter name or other source.

Example: google

utm_termstring

Urchin Tracking Module term, used to note the keywords for the ad.

Example: testing+term

totalinteger

A total number of items.

Example: 20

tip

1 Sortable fields are client_id, first_session_date, tag_name, app_name, app_type, country_code, region_name, city_name, isp, conn_type_name, browser_name, device_name, user_lang, last_session_time, total_pageviews, total_goals, push_subscription_time, push_unsubscription_time, push_last_touched, push_last_clicked, ad_last_served, ad_last_clicked, ad_last_impression, last_clicked, push_wokenup, push_clicks, ad_served, ad_impressions, ad_spam_impressions, ad_clicks, ad_spam_clicks, ad_conversions, income, cost, conversion_score.

2 Filterable fields are client_id, first_session_date, tag_id, app_type, country_code, region, city, asn, conn_type, os_id, os_version, browser_id, browser_version, device_id, user_lang, timezone, last_session_time, total_sessions, total_pageviews, total_goals, comment, utm_source, utm_medium, utm_campaign, utm_term, utm_content, push_subscription_time, push_last_clicked, ad_last_served, ad_last_clicked, ad_last_impression, last_clicked, push_unsubscription_time, push_last_touched, push_credentials, push_status, push_wokenup, push_clicks, retargeting, remote_user_id, ad_served, ad_impressions, ad_spam_impressions, ad_clicks, ad_spam_clicks, ad_conversions, income, cost, extra, is_woken_up, click_id, mobile_phone_number, sms_subscription_time, sms_status, email, email_subscription_time, email_status, conversion_score.

3 if you don't send first_session_date it will filter by today's date.

4 if you want to filter users as clickers/non clickers, you should send values 0 or 1 on clicker parameter. Example: &clicker=1

Response examples

Copied

200

{
    "total": 20,
    "items": [
    {
      "client_id": "16959755123015102980",
      "first_session_date": "2023-09-29",
      "tag_id": "1704",
      "app_type": "web",
      "app_name": "dev.ocamba.info",
      "country_code": "RS",
      "region": "7581800",
      "city": "792078",
      "asn": "203512",
      "os_id": "4",
      "os_version": "10",
      "browser_id": "12",
      "browser_version": "117",
      "user_lang": "en",
      "timezone": "Europe/Belgrade",
      "last_session_time": "2023-09-29 08:18:35",
      "total_sessions": "1",
      "total_pageviews": "1",
      "total_goals": "0",
      "traffic_source_type": "Direct",
      "last_clicked": "1970-01-01 00:00:00",
      "push_status_str": "unknown",
      "push_wokenup": "0",
      "push_clicks": "0",
      "remote_user_id": "b8373f16-0a4b-4176-9074-f395dec19857",
      "ad_served": "0",
      "ad_impressions": "0",
      "ad_spam_impressions": "0",
      "ad_clicks": "0",
      "ad_spam_clicks": "0",
      "ad_conversions": "0",
      "income": "0",
      "cost": "0",
      "mobile_phone_number": "+12345678",
      "sms_subscription_time": "2024-05-29 08:59:35",
      "sms_status": "1",
      "email": "[email protected]",
      "email_subscription_time": "2024-05-29 08:59:35",
      "email_status": "1",
      "conversion_score": "25"
    }
  ]
}

{
  "total": 20,
  "items": [
    {
      "client_id": "1094",
      "company_id": "1000000",
      "first_session_date": "2022-01-13",
      "last_session_time": "2022-01-13 16:33:17",
      "tag_id": "1000",
      "tag_name": "Demo Tag",
      "tag_type": "web",
      "app_name": "delsystems.net",
      "country_code": "RS",
      "region": "5855797",
      "region_name": "Hawaii",
      "city": "2657896",
      "city_name": "New York",
      "asn": "2510",
      "isp": "Fujitsu",
      "conn_type": "2",
      "conn_type_name": "cellular",
      "os_id": "4",
      "os_name": "iOS",
      "os_version": "10",
      "browser_id": 12,
      "browser_name": "Chrome",
      "browser_version": "74",
      "device_id": 13,
      "device_name": "Blackberry",
      "user_lang": "en",
      "timezone": "Europe/Istanbul",
      "total_sessions": "10",
      "total_pageviews": "163",
      "total_goals": "163",
      "comment": "This is Ocamba User",
      "traffic_source_type": "link",
      "utm_source": "google",
      "utm_medium": "organic",
      "utm_campaign": "push_campaign",
      "utm_content": "logolink",
      "utm_term": "testing+term",
      "push_subscription_time": "2022-03-22 10:17:33",
      "push_unsubscription_time": "2022-02-17 23:11:00",
      "push_last_touched": "2022-03-20 20:45:11",
      "push_last_clicked": "2022-03-20 20:45:11",
      "ad_last_served": "2022-03-20 20:45:11",
      "ad_last_clicked": "2022-03-20 20:45:11",
      "ad_last_impression": "2022-03-20 20:45:11",
      "last_clicked": "2022-03-20 20:45:11",
      "push_credentials": "{\n  \"endpoint\":\"https://fcm.googleapis.com/fcm/send/example\"\n}",
      "push_status": "1",
      "push_status_str": "subscribed",
      "push_wokenup": "122",
      "push_clicks": "122",
      "retargeting": "{\n  \"retargeting\":\"test\",\n  \"test\":\"value\"\n}",
      "ad_served": "89",
      "ad_impressions": "1063",
      "ad_spam_impressions": "0",
      "ad_clicks": "10",
      "ad_spam_clicks": "0",
      "ad_conversions": "14",
      "ad_income": "2374.67",
      "cost": "0.33",
      "extra": "{\n  \"clicker\":\"1\"\n}",
      "mobile_phone_number": "+1441234567",
      "sms_subscription_time": "2022-03-22 10:17:33",
      "sms_status": "1",
      "email": "[email protected]",
      "email_subscription_time": "2022-03-22 10:17:33",
      "email_status": "1",
      "conversion_score": "15"
    }
  ]
}

List Users

GET /usersCopied https://api.ocamba.com/v1/hood/users

GET /users
Copied
`https://api.ocamba.com/v1/hood/users`