View Conversion report
Copied
https://api.ocamba.com/v1/hood/reports/conversions
Copied
https://api.ocamba.com/v1/hood/reports/conversions
Obtain various conversion reports
Rate limits:
Burst: 10/s
Steady: 150/m
Name
Descriptionsortstring
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
200 - OK
Name
Descriptionassignedinteger
DimensionIndicates whether this event is formally assigned or attributed to a specific deal. A typical convention might be 0 = unassigned, 1 = assigned. example: 0
campaign_idinteger
DimensionUnique identifier for the campaign (e.g., "1002600"). In HoodEngage, a campaign is a fundamental entity that orchestrates audience targeting, creative templates (push, SMS, email, etc.), scheduling rules, and delivery parameters. This ID ties all performance data and analytics back to a specific campaign.
Example: 1002600
campaign_namestring
DimensionHuman-readable name of the campaign (e.g., "Chrismats Sale - Special discount"). Helps users easily identify and manage distinct campaigns within HoodEngage.
Example: Blackfriday Worldwide
client_idinteger
DimensionThe unique ID of the user or client who triggered the conversion event. It links the conversion back to a specific user profile or session within HoodEngage ecosystem.
Example: 18828993939090293000
container_idinteger
DimensionUnique identifier assigned by the HoodEngage app for a container resource. A container is an editable resource that centralizes settings for push notifications, analytics, crash reporting, user consent, and various lead-generation features (e.g., newsletter or SMS pop-ups). These changes are applied upon the next user session or SDK run.
Example: 126598752
container_namestring
DimensionThe name given by the user when creating a container..
Example: BBC Network US
conversion_idinteger
DimensionA unique identifier (e.g., 1000120) for a specific conversion, generated by the HoodEngage platform. This ID is used to track and reference a particular conversion event for reporting, billing, and analytics.
Example: 1000120
conversion_namestring
DimensionA human-readable name (e.g., "Example conversion") for the conversion event. It aids in distinguishing different types of conversions within analytics or reporting.
Example: Example conversion
country_codestring
DimensionTwo-letter country code, typically derived from the visitor’s IP address (ISO 3166-1 alpha-2 codes).
Example: US
country_namestring
DimensionOfficial country name derived from country_code.
Example: United States
currency_codestring
DimensionThe currrency code of the conversion. Must be USD.
Example: USD
Possible values: USD
delivery_datedate
DimensionThe scheduled date (YYYY-MM-DD) on which the campaigns was executed. Often used to group reporting data by the day a conversion opportunity was created or delivered.
Example: 2021-12-27
delivery_timedate
DimensionThe time when message was delivered.
Example: 2024-06-14T09:34:52Z
device_typestring
DimensionThe type of device used by the user (e.g., desktop, mobile, unknown). Typically determined by user agent analysis or environment detection.
Example: mobile
Possible values: desktop | mobile | unknown
engagement_scoreinteger
DimensionA metric indicating the effectiveness of HoodEngage user in driving desired user actions. Higher scores reflect better conversion performance and are based on tracked events and user behavior.
Example: 15
eventstring
DimensionThe event code used for attributing and validating this conversion. Conversion is recognized only if this event matches the defined structure (e.g., a purchase event for a CPI or CPA model).
Example: 12345
event_datedate
DimensionThe date (YYYY-MM-DD) when the statistic was recorded or the conversion was observed. Often used to group or filter analytics data by day.
Example: 2024-06-14
event_timedate
DimensionThe more precise timestamp (e.g., YYYY-MM-DDThh:mm:ssZ) when the statistic or conversion event occurred. This can be used for time-based analytics (hourly, minute-level segmentation).
Example: 2024-06-14T09:34:52Z
partner_idinteger
DimensionUnique identifier assigned by the HoodEngage app for a partner. A partner can be an advertiser, publisher, or both, and typically represents a business, brand, or organization within the HoodEngage ecosystem. Partners can have multiple managers, each with their own account and permissions, and may oversee multiple containers or applications.
Example: 968742523
partner_namestring
DimensionThe user-defined name for a HoodEngage partner entity. A partner can be an advertiser, publisher, or both, and typically represents a business, brand, or organization within the HoodEngage ecosystem. Partners can have multiple managers, each with their own account and permissions, and may oversee multiple containers or applications.
pricenumber (decimal)
DimensionThe monetary value associated with occured conversion (e.g., 12.5). Calculated or assigned based on the pricing model (see **structure**) and the outcome of the conversion event.
Example: 12.5
referenceinteger
DimensionA unique identifier provided by the advertiser or external system to ensure the same conversion is not counted more than once. Helps maintain consistent tracking across multiple platforms.
Example: 12345
scorestring
DimensionA 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
DimensionThe unique ID of a browser session generated by HoodEngage. Used to correlate multiple events or actions within a single user session, providing context for how the conversion was reached.
Example: 12345
spaminteger
DimensionInternal spam conversion identifier.
Example: 512
spam_reasonstring
DimensionReason why the conversion is spam.
Example: repeated
structurestring
DimensionDefines the pricing model used to calculate payment or revenue for this conversion. For instance, cpi (cost-per-install), cpa (cost-per-action), or cpc (cost-per-click). Only conversions matching the relevant event criteria are billed under the specified model.
Example: cpi
Possible values: unknown | cpc | cpm | cpa | cpi | cpl | cpe | cps | cpv | performance-based | subscription-based | flat-fee | hybrid
task_idinteger
DimensionDEPRACATED Unique task identifier generated by HoodEngage.
Example: 1002600
task_namestring
DimensionDEPRACATED The task name.
Example: Demo task
typestring
DimensionIndicates whether the conversion is tied to a publisher (ssp) or an advertiser (dsp). - ssp: Supply-Side Partner, typically a publisher generating traffic. - dsp: Demand-Side Partner, typically an advertiser or marketer funding the campaign.
Example: ssp
Possible values: ssp | dsp
tip1 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.
note1 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.
- 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.