Get analytics report for item(s)

get

https://{region}-api-freshrelevance.dotdigital.com/api/{website_id}/reports/item/{type}/{slugs}/

Retrieves an analytics report for a entity type and specific item(s) for the specified filter criteria.

Path Params

website_id

string

required

Website ID for the account you are posting data to.

type

string

enum

required

The type of entity you want an analytics report for.

campaign - Campaign daily report
campaigns_details - Campaign details
slot - Slot daily report
smartblock - Smartblock daily report
trigger - Trigger daily report

Allowed:

slugs

array of strings

required

Comma delimited list of ids you want to filter the report to.

slugs*

Query Params

format

string

enum

required

Get data in JSON format.

Allowed:

limit

integer

≥ 1

Defaults to 25

Get this number of records to return in results array (pagination).

page

integer

Defaults to 1

Which page of results you wish to return; First page is indexed as 1.

date_start

date-time

Start date for the data in ISO-8601 format, defaults to the last 30 days.

date_end

date-time

End date for the data in ISO-8601 format, defaults to today.

extragroup

string

enum

The field to sort result by.

Responses

401

Unauthorized

403

Forbidden - Usually you are requesting data for a website you don't have access to.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The page of analytics data.

400An error occurred