View Push-delivery report

Copied

                https://api.ocamba.com/v1/hood/reports/push-delivery

Push-delivery report enables analysis of critical parameters and essential information like Event Date, Push WokenUps, Push Clicks, Push Ctr, Push Subscriptions, Push Unsubscriptions and Push User Growth

query Parameters

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

outstring

Data format output - 'csv' (default) or 'json'.

Example: out=json

resolutionstring

Data resoulution, supported values 'hour', 'day'.

Example: resolution=hour

fieldsstringrequired

Fields is array of dimensions and measures. You can use dimensions to categorize, segment, and reveal the details in your data. Measures contain numeric, quantitative values that you can measure. At least one measure is required.

Example: delivery_date,tag_id,task_name,os_name,delivered,impression

Response status codes

200 - OK

Name

Description

automation_idinteger

Dimension
The EBS Automation id generated on ocamba platform.

Example: 1029607

automation_namestring

Dimension
The EBS Automation name created on ocamba platform.

Example: New Ebs Automation

browser_idinteger

Dimension
Unique browser identifier.

Example: 10

browser_namestring

Dimension
The browser name.

Example: Chrome

city_idinteger

Dimension
The GeoName identifier of the city.

Example: 6354908

city_namestring

Dimension
The name of the city.

Example: Sydney

clickinteger

Measure
The total number of valid clicks.

Example: 1562

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

conversioninteger

Measure
The total number of conversions.

Example: 12

country_codestring

Dimension
The code of the geographical country.

Example: RS

country_namestring

Dimension
The name of the geographical country.

Example: Serbia

ctdrfloat

Measure
The rate of clicks to delivered.

Example: 1.23

deliveredinteger

Measure
The total number of delivered ads.

Example: 888248

delivery_datedate

Dimension
The task execution date.

Example: 2021-12-27

delivery_ratefloat

Measure
The rate of wokenup to total users.

Example: 0.54

failedinteger

Measure
The total number of users failed to receive ads.

Example: 9

impressioninteger

Measure
The total number of impressions.

Example: 15268

incomefloat

Measure
The total income.

Example: 125.65

os_idinteger

Dimension
Unique operating system identifier.

Example: 12

os_namestring

Dimension
The operating system name.

Example: Android

push_ctrfloat

Measure
The rate of clicks to impressions.

Example: 10.84

push_unsubscriptionsinteger

Measure
The total number of push unsubscribed users.

Example: 2123

regioninteger

Dimension
The GeoName ID of the region.

Example: 123984

region_namestring

Dimension
The name of the region.

Example: Morava

spam_clickinteger

Measure
The total number of spam clicks.

Example: 94

tag_idinteger

Dimension
Unique application identifier generated by Ocamba.

Example: 126598752

tag_namestring

Dimension
The tag name.

Example: Demo tag

task_idinteger

Dimension
Unique task identifier generated by Ocamba.

Example: 1002600

task_namestring

Dimension
The task name.

Example: Demo task

total_clickinteger

Measure
The total number of clicks, including spam clicks.

Example: 1656

total_userinteger

Measure
The total number of users.

Example: 2897

user_agestring

Dimension
The range user age.

Example: 8-30

user_age_by_hourstring

Dimension
The range user age by hour.

Example: 17

wokenupinteger

Measure
The total number of wokenup users.

Example: 480876

zone_idinteger

Dimension
The zone id generated on ocamba platform.

Example: 1029607

zone_namestring

Dimension
The zone name created on ocamba platform.

Example: New zone

tip

1 Sortable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, os_id, os_name, browser_id, browser_name, user_age, user_age_by_hour, total_user, push_unsubscriptions, delivered, failed, wokenup, impression, total_click, spam_click, click, conversion, income, push_ctr, ctdr, delivery_rate, country_code, country_name, region_name, zone_id, zone_name, automation_id, automation_name and city_name.

2 Filterable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, os_id, os_name, browser_id, browser_name, user_age, user_age_by_hour, total_user, push_unsubscriptions, delivered, failed, impression, total_click, spam_click, click, conversion, income, push_ctr, ctdr, delivery_rate, country_code, country_name, region, region_name, zone_id, zone_name, automation_id, automation_name, city_id and city_name.

3 API provided filling empty entry points in between first and last date/hour. You should set with_fill parameter to true, but just in case the date dimension is requested only. It is in relation with resolution. You should pass day or hour, which defines what type of breakdown you request, default setup displays daily breakdown.

4 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.

5 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, quarter-to-date.

note

1 When filtering stat_date, 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

200

[
    {
        "task_id":"100477",
        "delivery_date":"2022-08-05T00:00:00Z",
        "total_user":0,
        "push_unsubscriptions":0,
        "delivered":0,
        "failed":0,
        "wokenup":3,
        "total_click":0
    },
    {
        "task_id":"15432861",
        "task_name":"16596949165579907044",
        "delivery_date":"2022-08-05T00:00:00Z",
        "total_user":1,
        "push_unsubscriptions":0,
        "delivered":1,
        "failed":0,
        "wokenup":1,
        "total_click":0
    }
]

{
  "delivery_date": "2021-12-27",
  "tag_id": 126598752,
  "tag_name": "Demo tag",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "task_id": 1002600,
  "task_name": "Demo task",
  "os_id": 12,
  "os_name": "Android",
  "browser_id": 10,
  "browser_name": "Chrome",
  "user_age": "8-30",
  "user_age_by_hour": "17",
  "city_id": 6354908,
  "city_name": "Sydney",
  "region": 123984,
  "region_name": "Morava",
  "country_code": "RS",
  "country_name": "Serbia",
  "zone_id": 1029607,
  "zone_name": "New zone",
  "automation_id": 1029607,
  "automation_name": "New Ebs Automation",
  "total_user": 2897,
  "push_unsubscriptions": 2123,
  "delivered": 888248,
  "failed": 9,
  "wokenup": 480876,
  "impression": 15268,
  "total_click": 1656,
  "spam_click": 94,
  "click": 1562,
  "conversion": 12,
  "income": 125.65,
  "push_ctr": 10.84,
  "ctdr": 1.23,
  "delivery_rate": 0.54
}

View Push-delivery report

GET /reports/push-deliveryCopied https://api.ocamba.com/v1/hood/reports/push-delivery

GET /reports/push-delivery
Copied
`https://api.ocamba.com/v1/hood/reports/push-delivery`