List Profile
List Profile
GET
https://api.ocamba.com/v1/hood/profiles
Returns a list of profiles
Rate limits:
Burst: 10/s
Steady: 150/m
Query parameters
parametersResponse schemas
›
200
application/json
›
500
application/json
GET https://api.ocamba.com/v1/hood/profiles HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/profiles" \
-H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/profiles", {
method: "GET",
headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/profiles");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer $token"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
Responses
200 OK
HTTP/1.1 200 OK
Content-Type: application/json
{
"total": 48315,
"items": [
{
"id": "1094",
"company_id": "1000000",
"status": "1",
"container_id": "39054",
"container_name": "Demo Tag",
"app_type": "web",
"app_name": "blic.rs",
"country_code": "RS",
"country_name": "Serbia",
"region": "5855797",
"region_name": "Hawaii",
"city": "2657896",
"city_name": "New York",
"asn": "2510",
"isp": "Fujitsu",
"os_id": "4",
"os_name": "iOS",
"os_version": "10",
"browser_id": 12,
"browser_name": "Chrome",
"browser_version": "74",
"conn_type": "2",
"conn_type_name": "cellular",
"profile_lang": "en",
"lang_name": "English",
"timezone": "Europe/Istanbul",
"total_sessions": "10",
"total_pageviews": "163",
"total_goals": "163",
"comment": "New profile",
"push_credentials": "{\n \"endpoint\":\"https://fcm.googleapis.com/fcm/send/example\"\n}",
"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",
"cost": "0.33",
"income": "1.55",
"utm_source": "google",
"utm_medium": "organic",
"utm_campaign": "push_campaign",
"utm_content": "logolink",
"utm_term": "testing+term",
"custom_properties": "{\n \"clicker\":\"1\"\n}",
"mobile_phone_number": "+49658245684",
"email": "[email protected]",
"metadata": {
"encrypted": [
null
]
},
"organization_id": "1000023",
"organization_name": "Org Name LLC",
"organization_domain": "domain.example.com",
"pns_id": "2",
"engagement_score": 15,
"conversion_score": "15",
"lists": [
"1000102"
],
"full_name": "John Doe",
"subscription": {
"push": {
"status": "1",
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
},
"sms": {
"status": "1",
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
},
"email": {
"status": "1",
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
}
},
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
}
]
}
500 Internal Server Error
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{
"code": 500,
"title": "Internal server error.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses
Tip
1
Sortable fields are: id, status, container_name, app_type, app_name, country_code, region_name, city_name, isp, conn_type_name, browser_name, device_name, user_lang, ad_last_serverd, ad_last_clicked, ad_last_impression, push_unsubscription_time, push_last_touched, ad_served, ad_impressions, ad_clicks, ad_spam_clicks, ad_conversions, income, cost, engagement_score, conversion_score, create_time, update_time.
2
Filterable fields are: id, status, container_id, container_name, app_type, app_name, country_code, country_name, region, region_name, city, city_name, asn, conn_type, os_id, os_name, os_version, browser_id, browser_version, device_id, user_lang, lang_name, timezone, last_session_time, total_sessions, total_pageviews, total_goals, comment, utm_source, utm_medium, utm_campaign, utm_term, utm_content, ad_last_serverd, ad_last_clicked, ad_last_impression, push_unsubscription_time, push_last_touched, push_wokenup, is_wokenup, push_clicks, click_id, retargeting, remote_user_id, ad_served, ad_impressions, ad_clicks, ad_spam_clicks, ad_conversions, income, cost, custom_data, engagement_score, conversion_score, subscription, create_time, update_time.