Date Range APIs

Retrieve dateranges for user

Changed on

Retrieves commonly used date ranges by the user so that they can be reused throughout the product

get/dateranges

Request

  • Base URL: https://cja.adobe.io
  • URL: https://cja.adobe.io/dateranges
  • Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Query parameters

localestring

Locale

filterByIdsstring

Filter list to only include date ranges in the specified list (comma-delimited list of IDs). This has filtered Ids from tags, approved, favorites and user specified Ids list.

limitinteger

Number of results per page

pageinteger

Page number (base 0 - first page is "0")

expansionstring[]

Comma-delimited list of additional date range metadata fields to include on response.

includeTypestring[]

Include additional date ranges not owned by user.

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Response

successful operation

idstring

System generated id

namestring
descriptionstring
rsidstring

The report suite id for which the component was created/updated

reportSuiteNamestring

The report suite name for which the component was created/updated

definitionobject
siteTitlestring
modifiedstring date-time
createdstring date-time

Changes

  • 451e9905bec7Revision changes
    • breaking

      added the new required header request parameter Authorization

    • breaking

      added the new required header request parameter x-api-key

    • breaking

      added the new required header request parameter x-gw-ims-org-id