View Conversion report

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

Obtain various conversion reports

query Parameters
Arrow
Name
Description
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
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
Response status codes
Arrow
200 - OK
Arrow
Name
Description
assignedinteger
Dimension
Describes if conversion is assigned.
client_idinteger
Dimension
The id of the user that triggered the conversion event.


Example: 18828993939090293000
container_idinteger
Dimension
Unique container identifier generated on Ocamba platform.


Example: 126598752
container_namestring
Dimension
Container name created on Ocamba platform.


Example: test.demo.com
conversion_idinteger
Dimension
Unique conversion identifier generated by Ocamba.


Example: 1000120
conversion_namestring
Dimension
The conversion name.


Example: Example conversion
country_codestring
Dimension
The code of the geographical country.


Example: RS
country_namestring
Dimension
The name of the geographical country.


Example: Serbia
currency_codestring
Dimension
The currrency code of the conversion. Must be USD.


Example: USD

Possible values: USD
delivery_datedate
Dimension
The task execution date.


Example: 2021-12-27
delivery_timedate
Dimension
The time when message was delivered.


Example: 2024-06-14T09:34:52Z
device_typestring
Dimension
The type of the device.


Example: mobile

Possible values: desktop | mobile | unknown
eventinteger
Event used for attributing conversion, determining price and campaign/user score. Conversion is attributed only if event matches the conversion structure.


Example: 12345
event_datedate
Dimension
The date on which the statistic was taken.


Example: 2024-06-14
event_timedate
Dimension
The date on which the statistic was taken.


Example: 2024-06-14T09:34:52Z
partner_idinteger
Dimension
Deals partner id created on Ocamba platform.


Example: 1000002
partner_namestring
Dimension
Deals partner name created on Ocamba platform.


Example: Jane Doe
pricenumber (decimal)
Dimension
The price of conversion.


Example: 12.5
referenceinteger
Unique ID provided by the advertiser, used to make sure conversion is counted only once.


Example: 12345
scorestring
Dimension
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
session_idinteger
ID of a browser session generated by Ocamba.


Example: 12345
spaminteger
Dimension
Internal spam conversion identifier.


Example: 512
spam_reasonstring
Dimension
Reason why the conversion is spam.


Example: repeated
structurestring
Determines how payments will be calculated for this deal.


Example: cpi

Possible values: unknown | cpc | cpm | cpa | cpi | cpl | cpe | cps | cpv | performance-based | subscription-based | flat-fee | hybrid
tag_idinteger
Dimension
Hood tag id created on Ocamba platform.


Example: 12752
tag_namestring
Dimension
Hood tag name created on Ocamba platform.


Example: test.demo.com
task_idinteger
Dimension
Unique task identifier generated by Ocamba.


Example: 1002600
task_namestring
Dimension
The task name.


Example: Demo task
typestring
Determines if conversion is for advertiser(dsp) or publisher(ssp).


Example: ssp

Possible values: ssp | dsp

tip
1 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.
2 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.
3 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.
4 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
1 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.

Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
[
  {
    "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"
  }
]

{
  "delivery_date": "2021-12-27",
  "conversion_id": 1000120,
  "conversion_name": "Example conversion",
  "task_id": 1002600,
  "task_name": "Demo task",
  "event_date": "2024-06-14",
  "event_time": "2024-06-14T09:34:52Z",
  "client_id": 18828993939090293000,
  "delivery_time": "2024-06-14T09:34:52Z",
  "price": 12.5,
  "currency_code": "USD",
  "tag_id": 12752,
  "tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "device_type": "mobile",
  "country_code": "RS",
  "country_name": "Serbia",
  "score": "15",
  "session_id": 12345,
  "spam": 512,
  "spam_reason": "repeated",
  "partner_id": 1000002,
  "partner_name": "Jane Doe",
  "reference": 12345,
  "event": 12345,
  "structure": "cpi",
  "type": "ssp"
}