Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Body
NearByLocation request model
NearByLocation request model
Number of records returned on a single page
10
Number of records skipped before filtering records
0
Item property on which data needed to be sorted on.
"updatedAt"
Direction of sorting i.e ascending or descending
asc
, desc
"desc"