Get Smartblocks

get

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

Retrieves the Smartblocks for the website in JSON format.

Path Params

website_id

string

required

Website ID for the account you are posting data to.

Query Params

format

string

enum

required

Get data in JSON format.

Allowed:

page

integer

Defaults to 1

Which page of results you wish to return.

limit

integer

Defaults to 25

The limit of the amount of results to display per page.

filterByType

array of strings

Filters by Smartblock type(s)

filterByType

tags

folder_id

string

Filters by folder

search_string

string

Filters to only SmartBlocks that has the specified string in their name

include_deleted

boolean

Defaults to false

Include deleted Smartblocks in the results

load_slot_list

boolean

Defaults to false

Include a list of Slots that contain the SmartBlock in the results

include_live_flag

boolean

Defaults to false

Include the field is_live which indicates whether the Smartblock has recently recieved impressions in the results

typeCount

boolean

Defaults to false

Include a list of the counts of all Smartblock types in the results

Responses

200The Smartblock requested

403Unauthorized / forbidden