Get Smartblock statistics

get

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

This API endpoint returns the requested information and statistics for all Smartblocks. When filtered it will return the requested information and statistics for Smartblocks matching the filters.

📘
When filtered, the operation returns the requested information and statistics for SmartBlocks matching the filters.

Path Params

website_id

string

required

Website ID for the account you are posting data to.

Query Params

start

string

required

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

end

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

page

integer

Defaults to 1

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

limit

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

Allowed:

metered

boolean

Filter based on whether a Smartblock is metered or unmetered

in_slot

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

name

string

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

sort_by

string

Sort by statistic.

sort_type

string

enum

Order in which to sort the results

Allowed:

folder_id

string

Filter for Smartblocks in a specific folder

optimization_test_id

string

Filter for Smartblock data which was part of a specific optimisation

overtime_interval

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.

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Successful Request

400Bad Request