List Profile Analytics

List Profile Analytics

GET https://api.ocamba.com/v1/hood/profiles/{id}/analytics

Returns a list of analytics events for a single profile

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Path parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/profiles/{id}/analytics HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/profiles/{id}/analytics" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/profiles/{id}/analytics", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/profiles/{id}/analytics");
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": [
    {
      "event_time": "2021-10-30 14:27:26",
      "event_date": "2021-10-30",
      "page_url": "https://dev.delsystems.net/",
      "event": "pageview"
    }
  ]
}

400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

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
If the event_time filter isn’t set, the endpoint will return analytics list for the last 7 days.
2
Sortable fields is: event_date, event_time.
3
Filterable fields are: event, page_url, event_time.