View Delivery Basic report

Copied

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

Delivery Basic report enables analysis of critical parameters and essential information like Delivery Date, Delivery rate, Success rate, Error rate

Rate limits:

Burst: 10/s
Steady: 150/m

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,delivered,error_rate

Response status codes

200 - OK

Name

Description

avg_delivery_durationfloat

Measure
The average delivery duration of request.

Example: 0.54

clickinteger

Measure
The total number of valid clicks.

Example: 9

container_idinteger

Dimension
Unique 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

Dimension
Name provided by the user on creation for a container.

Example: BBC Network US

deliveredinteger

Measure
The total number of delivered messages.

Example: 888248

delivery_datedate

Dimension
The execution date.

Example: 2021-12-27

delivery_ratefloat

Measure
The rate of delivered to total users.

Example: 0.54

error_ratefloat

Measure
The rate of undelivered to success.

Example: 0.54

failedinteger

Measure
The total number of users failed to receive message.

Example: 9

failure_ratefloat

Measure
The rate of total failed to total users.

Example: 0.54

integration_idstring

Dimension
A unique ID (e.g., "SMS") representing the specific integration or endpoint used for message delivery. For instance, a Twilio integration, custom email connector, or in-house push gateway.

Example: SMS

integration_namestring

Dimension
A descriptive name (e.g., "Telesign SMS") for the integration or connector. Useful for distinguishing different implementations or accounts of the same provider type.

Example: Telesign SMS

provider_error_ratefloat

Measure
The rate of provider failed to total users.

Example: 0.54

provider_failedinteger

Measure
The total number of users failed to send message to.

Example: 9

provider_idstring

Dimension
A unique identifier for the Provider generated by the HoodEngage platform. This ID helps track which provider responsible for delivering the messages to end-user.

Example: 1

provider_namestring

Dimension
A human-readable name of the Provider. Allows quick identification of the delivery service or platform used. example: 'Telesign'

provider_typestring

Dimension
The type of provider used for message delivery (e.g., "SMS", "Email", "Push"). This classification helps distinguish different delivery channels.

Example: SMS

spam_clickinteger

Measure
The total number of spam clicks.

Example: 9

successinteger

Measure
The total number of users successfully sent message to.

Example: 9

success_ratefloat

Measure
The rate of success to total users.

Example: 0.54

tag_idinteger

Dimension
DEPRACATED Unique application identifier generated by HoodEngage.

Example: 126598752

tag_namestring

Dimension
DEPRACATED The tag name.

Example: Demo tag

task_idinteger

Dimension
DEPRACATED Unique task identifier generated by HoodEngage.

Example: 1002600

task_namestring

Dimension
DEPRACATED The task name.

Example: Demo task

total_clickinteger

Measure
The total number of all clicks.

Example: 9

total_failedinteger

Measure
The total number of users failed to receive message and to send message to.

Example: 9

total_userinteger

Measure
The total number of users targeted by the task or campaign. Typically determined by combining and deduplicating segments or subscriber lists. example: 888248

undeliveredinteger

Measure
The total number of undelivered messages.

Example: 48

tip

1 Sortable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, provider_type, provider_id, provider_name, integration_id, integration_name, total_user, delivered, undelivered, success, failed, provider_failed, total_failed, success_rate, delivery_rate, error_rate, provider_error_rate, failure_rate, avg_delivery_duration, click, spam_click, total_click.

2 Filterable fields are: delivery_date, tag_id, tag_name, container_id, container_name, task_id, task_name, provider_type, provider_id, provider_name, integration_id, integration_name, total_user, delivered, undelivered, success, failed, provider_failed, total_failed, success_rate, delivery_rate, error_rate, provider_error_rate, failure_rate, avg_delivery_duration, click, spam_click, total_click.

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, 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
    },
    {
        "task_id":"15432861",
        "task_name":"16596949165579907044",
        "delivery_date":"2022-08-05T00:00:00Z",
        "total_user":1,
        "push_unsubscriptions":0,
        "delivered":1,
        "failed":0
    }
]

{
  "delivery_date": "2021-12-27",
  "tag_id": 126598752,
  "tag_name": "Demo tag",
  "container_id": 126598752,
  "container_name": "BBC Network US",
  "task_id": 1002600,
  "task_name": "Demo task",
  "provider_type": "SMS",
  "provider_id": "1",
  "integration_id": "SMS",
  "integration_name": "Telesign SMS",
  "delivered": 888248,
  "undelivered": 48,
  "success": 9,
  "provider_failed": 9,
  "failed": 9,
  "click": 9,
  "total_failed": 9,
  "delivery_rate": 0.54,
  "success_rate": 0.54,
  "error_rate": 0.54,
  "provider_error_rate": 0.54,
  "failure_rate": 0.54,
  "avg_delivery_duration": 0.54,
  "spam_click": 9,
  "total_click": 9
}

View Delivery Basic report

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

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