Reporting API

See the Reporting User Guide for more information

post/reports

Request

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

Query parameters

includeOberonXmltrue | false

Controls if Oberon XML should be returned in the response - DEBUG ONLY

includePlatformPredictiveObjectstrue | false

Controls if platform Predictive Objects should be returned in the response. Only available when using Anomaly Detection or Forecasting- DEBUG ONLY

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.

Request body

rsidstring
dataIdstring
dimensionstring
anchorDatestring

Response

Successful operation

totalPagesinteger
firstPageboolean
lastPageboolean
numberOfElementsinteger
numberinteger
totalElementsinteger
messagestring
reportIdstring
summaryDataobject
oberonRequestXMLstring[]
oberonResponseXMLstring[]
predictiveRequestObjectsstring[]
predictiveResponseObjectsstring[]

Changes

    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • 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