View Provider-errors report

Copied

                https://api.ocamba.com/v1/hood/reports/provider-errors

Provider-errors report helps troubleshooting settings that result in errors with the goal of eliminating the error in the future

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

app_namestring

Dimension
Hood application name created on Ocamba platform.

Example: delsystems.net

browser_idinteger

Dimension
The id of the browser.

Example: 10

browser_namestring

Dimension
The name of the browser.

Example: Chrome

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

country_codestring

Dimension
The code of the geographical country.

Example: RS

country_namestring

Dimension
The name of the geographical country.

Example: Serbia

device_idinteger

Dimension
The identifier of the device.

Example: 5

device_namestring

Dimension
The name of the device.

Example: sony

error_codestring

Dimension
Error codes.

Example: 110

integration_idstring

Dimension
A unique identifier of the Integration, generated by the Ocamba platform.

Example: SMS

integration_namestring

Dimension
The Name of the integration.

Example: Ocamba

os_idinteger

Dimension
The identifier of the operating system.

Example: 12

os_namestring

Dimension
The name of the operating system.

Example: Android

provider_idstring

Dimension
A unique identifier of the Provider, generated by the Ocamba platform.

Example: SMS

provider_namestring

Dimension
The name of the Provider.

Example: Ocamba

provider_typestring

Dimension
The provider type.

Example: SMS

push_task_idinteger

Dimension
Unique push task identifier generated by Ocamba.

Example: 1002600

push_task_namestring

Dimension
The push task name.

Example: Demo task

push_typestring

Dimension
The name of the push type.

Example: ios

requestsinteger

Measure
The total number of requests.

Example: 1

retry_countinteger

Measure
The total number of retry count.

stat_datedateTime

Dimension
The day of the event.

Example: 2021-12-27

status_codestring

Dimension
HTTP response status codes.

Example: 204

tag_idinteger

Dimension
Unique tag identifier generated on Ocamba platform.

Example: 126598752

tag_namestring

Dimension
Tag name created on Ocamba platform.

Example: test.demo.com

total_durationinteger

Measure
The total number of total duration.

Example: 230

user_agestring

Dimension
The range user age.

Example: 8-30

zone_idinteger

Dimension
The zone id generated on ocamba platform.

Example: 1029607

zone_namestring

Dimension
The zone name created on ocamba platform.

Example: Push zone

tip

1 Sortable fields are: stat_date, tag_id, tag_name, container_id, container_name, app_name, provider_type, provider_id, provider_name, integration_id, integration_name, zone_id, zone_name, browser_id, browser_name, device_id, device_name, os_id, os_name, country_code, country_name, push_type, push_task_id, push_task_name, status_code, error_code, user_age, requests, retry_count, total_duration.

2 Filterable fields are: tag_id, zone_id, tag_name, container_id, container_name, app_name, provider_type, provider_id, provider_name, integration_id, integration_name, zone_name, browser_id, browser_name, device_id, device_name, os_id, os_name, country_code, country_name, push_type, push_task_id, push_task_name, status_code, error_code, requests, retry_count, total_duration.

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

[
    {
        "stat_date":"2022-09-28T00:00:00Z",
        "tag_id":"1704",
        "tag_name":"DEV Ocamba Info",
        "zone_id":"0",
        "browser_id":"0",
        "browser_name":"Unknown",
        "device_id":"0",
        "device_name":"Unknown",
        "os_id":"10",
        "country_code":"PL",
        "country_name": "Poland",
        "push_type":"ios",
        "push_task_id":"15432493",
        "push_task_name":"testing",
        "status_code":"0",
        "error_code": "0",
        "user_age":"8-30",
        "requests":1,
        "retry_count":0,
        "total_duration":416
    },
    {
        "stat_date":"2022-09-28T00:00:00Z",
        "tag_id":"1303",
        "tag_name":"DS [DON'T TOUCH]",
        "app_name":"test-5",
        "zone_id":"3001868",
        "zone_name":"veljko push",
        "browser_id":"17",
        "browser_name":"Edge",
        "device_id":"0",
        "device_name":"Unknown",
        "os_id":"1",
        "os_name":"Windows OS",
        "country_code":"PL",
        "country_name": "Poland",
        "push_type":"web",
        "push_task_id":"15433308",
        "push_task_name":"v",
        "status_code":"401",
        "error_code": "0",
        "user_age":"31-75",
        "requests":3,
        "retry_count":0,
        "total_duration":114
    }
]

{
  "stat_date": "2021-12-27",
  "tag_id": 126598752,
  "tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "app_name": "delsystems.net",
  "provider_type": "SMS",
  "provider_id": "SMS",
  "provider_name": "Ocamba",
  "integration_id": "SMS",
  "integration_name": "Ocamba",
  "zone_id": 1029607,
  "zone_name": "Push zone",
  "browser_id": 10,
  "browser_name": "Chrome",
  "device_id": 5,
  "device_name": "sony",
  "os_id": 12,
  "os_name": "Android",
  "country_code": "RS",
  "country_name": "Serbia",
  "push_type": "ios",
  "push_task_id": 1002600,
  "push_task_name": "Demo task",
  "status_code": "204",
  "error_code": "110",
  "user_age": "8-30",
  "requests": 1,
  "total_duration": 230
}

View Provider-errors report

GET /reports/provider-errorsCopied https://api.ocamba.com/v1/hood/reports/provider-errors

GET /reports/provider-errors
Copied
`https://api.ocamba.com/v1/hood/reports/provider-errors`