Date Ranges

Returns a list of dateranges for the user

This API allows users to store commonly used date ranges so that they can be reused throughout the product.

get/{globalCompanyId}/dateranges

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

includeTypestring[]

Include additional dateranges not owned by user. The "all" option takes precedence over "shared"

expansionstring[]

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

localestring

Locale

filterByIdsstring

Filter list to only include date ranges in the specified list (comma-delimited list of IDs)

newDefinitionboolean

Use the new JSON def

filterByModifiedAfterstring

Filter list to only include date ranges modified since this date (ISO8601 format)

curatedRsidstring

Include the curatedItem status for given Rsid

limitinteger

Number of results per page

pageinteger

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

Headers

Authorizationstring required

The access token copied from your AA API client integration, prefixed with "Bearer ".

x-gw-ims-org-idstring required

The Organization ID copied from your AA API client integration.

x-api-keystring required

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

Response

successful operation

idstring
namestring
descriptionstring
modifiedstring date-time
companyIdinteger
ownerobject
definitionobject
templateboolean
createDatestring date-time
disabledDatestring date-time
curatedItemboolean
imsOrgIdstring
systemUserOwnedboolean
tagsobject[]
sharesobject[]
approvedboolean
favoriteboolean
usageSummaryobject

Changes