GuidesAPI Reference
API Reference
Select productLog inHelp centre

Get overview report

get
https://{region}-api-freshrelevance.dotdigital.com/api//reports/item/overview//

Retrieves an overview of the usage and analytics for an entity type for the specified filter criteria.

Path Params
string
required

Website ID for the account you are posting data to.

string
enum
required

The type of entity you want an overview report for.

Allowed:
Query Params
string
enum
required

Get data in JSON format.

Allowed:
integer
≥ 1
Defaults to 25

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

integer
Defaults to 1

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

date-time

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

date-time

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

string
enum

The field to sort result by.

integer
enum

The sort directon.

  • 1 - Ascending
  • -1 - Descending
Allowed:
Responses

401

Unauthorized

403

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

Updated 7 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago