View Campaigns Delivery report

Copied

                https://api.ocamba.com/v1/hood/reports/campaigns/delivery

Camapigns Delivery report enables analysis of critical parameters and essential information

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.

Response status codes

200 - OK

Name

Description

campaign_idinteger

Dimension
Unique campaign identifier generated by Ocamba.

Example: 1002600

campaign_namestring

Dimension
The campaign name.

Example: Demo campaign

channel_typestring

Dimension
The channel type.

Example: push

Possible values: push | adex_push | SMS | email

churninteger

Measure
Percent of unsubscribed user.

Example: 5

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

deal_idstring

Dimension
A unique identifier for the deal associated with the Campaign.

Example: 1000251

deal_namestring

Dimension
The Name of the deal associated with the Campaign.

Example: Ocamaba deal

deliveredinteger

Measure
The total number of delivered messages.

Example: 888248

dsp_partner_idinteger

Dimension
The hood partner id generated on Ocamba platform.

Example: 874214212

dsp_partner_namestring

Dimension
The hood partner name created on Ocamba platform.

Example: Default partner

failedinteger

Measure
The total number of users failed to receive message.

Example: 9

impressioninteger

Measure
The total number of impressions served.

Example: 9

run_datedate

Dimension
The execution date.

Example: 2021-12-27

sentinteger

Measure
The total number of sent messages.

Example: 9

ssp_partner_idinteger

Dimension
The hood partner id generated on Ocamba platform.

Example: 68745145

ssp_partner_namestring

Dimension
The hood partner name created on Ocamba platform.

Example: Default partner

total_clickinteger

Measure
The total number of all clicks.

Example: 9

total_userinteger

Measure
The total number of users targeted.

Example: 888248

unsubscribedinteger

Measure
The total number of users unsubscribed.

Example: 5

tip

1 Sortable fields are: run_date, container_id, container_name, campaign_id, campaign_name, deal_id, deal_name, ssp_partner_id, ssp_partner_name, dsp_partner_id, dsp_partner_name, channel_type, total_user, sent, delivered, unsubscribed, failed, impression, total_click, churn.

2 Filterable fields are: run_date, container_id, container_name, campaign_id, campaign_name, deal_id, deal_name, ssp_partner_id, ssp_partner_name, dsp_partner_id, dsp_partner_name, channel_type, total_user, sent, delivered, unsubscribed, failed, impression, total_click, churn.

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.

6 The metrics available for reporting vary depending on the channel type. Each channel has its own set of metrics that are tracked to monitor performance. Below is a breakdown of the metrics by channel type:
- push: total_user, sent, delivered, unsubscribed, failed, total_click, churn
- adex: total_user, sent, delivered, failed, impression, total_click
- sms: total_user, sent, delivered, failed, total_click
- email: total_user, sent, delivered, failed
- email custom provider: total_user, sent
When querying the Campaigns Delivery Report, ensure you specify the appropriate channel to retrieve the corresponding metrics.

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

[
    {
      {
        "container_name": "Example container",
        "campaign_id": "1000123",
        "campaign_name": "Campaign - Example",
        "run_date": "2024-11-14T12:45:00Z",
        "deal_id": "100011",
        "deal_name": "deal cycle",
        "ssp_partner_id": "1234567",
        "ssp_partner_name": "Ocamba",
        "dsp_partner_id": "1000499",
        "dsp_partner_name": "partner cycle",
        "channel_type": "email",
        "total_user": 1,
        "sent": 0,
        "delivered": 0,
        "failed": 1,
        "total_click": 0,
        "churn": 0
      },
      {
        "container_name": "Example container",
        "campaign_id": "1000123",
        "campaign_name": "Campaign - Example",
        "run_date": "2024-11-14T12:05:00Z",
        "deal_id": "1000557",
        "deal_name": "deal cycle",
        "ssp_partner_id": "1234567",
        "ssp_partner_name": "Ocamba",
        "dsp_partner_id": "1000499",
        "dsp_partner_name": "partner cycle",
        "channel_type": "adex_push",
        "total_user": 1,
        "sent": 1,
        "delivered": 5,
        "failed": 0,
        "total_click": 4,
        "churn": 0
      }
    }
]

{
  "run_date": "2021-12-27",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "campaign_id": 1002600,
  "campaign_name": "Demo campaign",
  "deal_id": "1000251",
  "deal_name": "Ocamaba deal",
  "dsp_partner_id": 874214212,
  "dsp_partner_name": "Default partner",
  "ssp_partner_id": 68745145,
  "ssp_partner_name": "Default partner",
  "channel_type": "push",
  "total_user": 888248,
  "delivered": 888248,
  "sent": 9,
  "failed": 9,
  "unsubscribed": 5,
  "churn": 5,
  "total_click": 9,
  "impression": 9
}

View Campaigns Delivery report

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

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