GuidesAPI Reference
API Reference
Select productLog inHelp centre

List Slots

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

Retrieves a list of all Slots.

Path Params
string
required

Website ID for the account you are posting data to.

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.

tags
array of strings

A comma seperated list of tags to match.

tags
string

If provided only slots contained in the specified folder will be returned.

string
enum

If provided only slots of the type in the specified will be returned.

  • e - Email slot
  • te - Triggered email slot
  • w - Web slot
Allowed:
string

Returns only Slots that have the search string in either it's name or slug parameters.

boolean
Defaults to false

Indicates whether to include deleted slots or not.

boolean
Defaults to false

Indicates whether to return the smartblocks field or not, containing l list of Smartblocks that are used in the slot.

boolean
Defaults to false

Indicates whether to include slots with no Smartblocks or not.

boolean
Defaults to false

Indicates whether to include is_live fields or not, which indicates that the content has recently received an impression.

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