View Conversion report

GET https://api.ocamba.com/v1/hood/reports/conversions

Obtain various conversion reports

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

›

200

application/json

›

400

application/json

›

500

application/json

curl -X GET \
 "https://api.ocamba.com/v1/hood/reports/conversions" \
  -H "Authorization: Bearer {TOKEN}"

const url = 'https://api.ocamba.com/v1/hood/reports/conversions';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

$ch = curl_init("https://api.ocamba.com/v1/hood/reports/conversions");
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

[
  {
    "client_id": "17236162066430100298",
    "tag_id": "1111",
    "tag_name": "Tag_name",
    "reference": "reference_example",
    "score": "10",
    "partner_id": "1000133",
    "partner_name": "Default partner",
    "conversion_id": "1000193",
    "country_code": "RS",
    "conversion_name": "some_conversion",
    "device_type": "desktop",
    "task_id": "15438584",
    "task_name": "some_task",
    "delivery_date": "2024-06-25T09:40:03Z",
    "price": "1.3",
    "spam_reason": "conversion inactive",
    "spam": "16",
    "structure": "cpc"
  },
  {
    "client_id": "17236162066430100298",
    "tag_id": "2222",
    "tag_name": "Tag_name",
    "reference": "reference_example",
    "score": "12",
    "partner_id": "1000133",
    "partner_name": "Default partner",
    "conversion_id": "1000194",
    "country_code": "RS",
    "conversion_name": "some_other_conversion",
    "device_type": "mobile",
    "task_id": "15438583",
    "task_name": "some_other_task",
    "delivery_date": "2024-06-25T09:40:03Z",
    "price": "1.85",
    "spam_reason": "conversion inactive",
    "spam": "16",
    "structure": "cpc"
  }
]

400 Bad Request

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

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

Responses

Tip

Sortable fields are: conversion_id, conversion_name, task_id, task_name, currency_code, price, delivery_date, event_date, event_time, spam, spam_reason, assigned, partner_id, partner_name, tag_id, tag_name, container_id, container_name, country_code, country_name, device_type, reference, score, session_id, type, event, structure, client_id.

Filtrable fields are: conversion_id, conversion_name, task_id, task_name, currency_code, price, delivery_date, event_date, event_time, spam, spam_reason, assigned, partner_id, partner_name, tag_id, tag_name, container_id, container_name, country_code, country_name, device_type, reference, score, session_id, type, event, structure, client_id.

To get data by the time in your local time zone, you should set tz query parameter to the specific time zone. See the list of valid time zones here -> https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List.

For easier search, Reports API gives you the possibility of using one of the following labels: today, yesterday, last-7-days, last-30-days, last-24-hours, this-month, last-month, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday and quarter-to-date.

Note

When filtering dates, use one of the following formats:

Single format: YYYY-mm-dd;

Displaying stats for this specific day
Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.
  
  Displaying stats in this specific range.
Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays “today” stats.

LinkedIn Facebook Instagram