GuidesAPI Reference
API Reference
Select productLog inHelp centre

Get SmartBlock statistics

get
https://{region}-api-freshrelevance.dotdigital.com/api//statistics/smartblocks

Returns the requested information and statistics for all SmartBlocks.

Path Params
string
required

Website ID for the account you are posting data to.

Query Params
string
required

The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'.

string
required

The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'.

statistics
array of strings
required

A comma seperated list of statistics that you would like the API to return. At least one statistic must be requested.

statistics*
ids
array of strings

Return only Smartblocks with IDs matching one of the supplied ID's.

ids
integer
Defaults to 1

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

integer
≥ 1
Defaults to 25

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

status
array of strings

Filter on Smartblock status, the available options are 'active', 'inactive' and 'archived'.

status
boolean

Filter based on whether a Smartblock is metered or unmetered

string

Filter for Smartblocks that have been shown in the specified slot (using the slot ID)

smartblock_type
array of strings

Filter to show only Smartblocks matching the specified smartblock type

smartblock_type
string

Filter by Smartblock name, finds SmartBlock's who's names include the search string supplied

string

Sort by statistic.

string
enum

Order in which to sort the results

Allowed:
string

Filter for Smartblocks in a specific folder

string

Filter for Smartblock data which was part of a specific optimisation

string
enum

Interval which overtime stats are returned in. Weekly starts from first day in starts. Monthly is by calendar month.

Allowed:
Responses

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