Report Suites API

The Analytics 2.0 Report Suites API endpoints provide methods for you to create and retrieve report suites, manage virtual report suites, and fetch supported timezones. The endpoints described in this guide are routed through analytics.adobe.io. To use them, you must first create a client with access to the Adobe Developer Console. For more information, see Getting started with the Analytics API.

Collections Suites

These endpoints provide methods for retrieving report suites in the collections service:

• GET a suite: Retrieves a single suite by ID
• GET all suites: Retrieves many report suites using search criteria

Virtual Report Suites

These endpoints provide methods for searching, creating, updating, validating, and deleting virtual report suites:

• GET all virtual report suites: Retrieves many virtual report suites using search criteria
• POST a virtual report suite: Creates a new virtual report suite
• GET a virtual report suite: Retrieves a single virtual report suite by ID
• PUT a virtual report suite: Updates configuration for a virtual report suite
• DELETE a virtual report suite: Deletes or disables a virtual report suite by ID
• POST validate a virtual report suite: Validates a virtual report suite configuration
• POST search virtual report suites: Retrieves many virtual report suites using a search body

Report Suites

These endpoints provide methods for retrieving timezones and creating report suites:

• GET timezones: Retrieves all supported timezones
• POST a report suite: Creates a new report suite

data-variant=info

data-slots=text

GET a suite

Use this endpoint to retrieve a single report suite by ID.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/collections/suites/{RSID}

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/collections/suites/examplersid?expansion=name,currency" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "rsid": "examplersid",
  "id": "examplersid",
  "name": "Example Suite",
  "currency": "USD",
  "calendarType": {
    "rsid": "examplersid",
    "anchorDate": "2024-01-01T00:00:00Z",
    "type": "GREGORIAN"
  },
  "timezoneZoneinfo": "US/Pacific"
}

Request example details

The example above requests the report suite with the ID examplersid and expands the name and currency fields.

Response example details

The example above returns a report suite with core metadata, including the rsid, name, and currency.

Request Parameters

The GET a suite endpoint includes the following request parameters:

Response Parameters

The following table describes the GET a suite response parameters:

GET all suites

Use this endpoint to retrieve many report suites using the provided search criteria.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/collections/suites

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/collections/suites?limit=10&page=0&rsidContains=example" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

[
  {
    "rsid": "examplersid",
    "id": "examplersid",
    "name": "Example Suite",
    "timezoneZoneinfo": "US/Pacific"
  }
]

Request example details

The example above requests the first page of report suites whose rsid contains example.

Response example details

The example above returns a list of suites that match the search criteria.

Request Parameters

The GET all suites endpoint includes the following request parameters:

Response Parameters

The following table describes the GET all suites response parameters:

GET all virtual report suites

Use this endpoint to retrieve many virtual report suites using search criteria.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites?limit=10&page=0&idContains=example" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

[
  {
    "id": "vrs_12345",
    "name": "Example VRS",
    "parentRsid": "examplersid",
    "segmentList": [
      "seg_001"
    ],
    "timezoneZoneinfo": "US/Pacific"
  }
]

Request example details

The example above requests the first page of virtual report suites whose IDs contain example.

Response example details

The example above returns a list of virtual report suites that match the search criteria.

Request Parameters

The GET all virtual report suites endpoint includes the following request parameters:

Response Parameters

The following table describes the GET all virtual report suites response parameters:

POST a virtual report suite

Use this endpoint to create a virtual report suite. The following attributes are required: name, parentRsid, and segmentList.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'POST' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
    "name": "Example VRS",
    "parentRsid": "examplersid",
    "segmentList": ["seg_001", "seg_002"],
    "description": "Example virtual report suite"
  }'

{
  "id": "vrs_12345",
  "name": "Example VRS",
  "parentRsid": "examplersid",
  "segmentList": [
    "seg_001",
    "seg_002"
  ],
  "description": "Example virtual report suite"
}

Request example details

The example above creates a virtual report suite named Example VRS with two segments.

Response example details

The example above returns the created virtual report suite and its assigned id.

Request Parameters

The POST a virtual report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the POST a virtual report suite response parameters:

GET a virtual report suite

Use this endpoint to retrieve a single virtual report suite by ID.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/{ID}

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/vrs_12345" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "id": "vrs_12345",
  "name": "Example VRS",
  "parentRsid": "examplersid",
  "segmentList": [
    "seg_001"
  ],
  "timezoneZoneinfo": "US/Pacific"
}

Request example details

The example above requests the virtual report suite with the ID vrs_12345.

Response example details

The example above returns the virtual report suite and its core metadata.

Request Parameters

The GET a virtual report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the GET a virtual report suite response parameters:

PUT a virtual report suite

Use this endpoint to update the configuration for a virtual report suite.

PUT https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/{ID}

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'PUT' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/vrs_12345" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
    "name": "Example VRS (Updated)",
    "parentRsid": "examplersid",
    "segmentList": ["seg_001", "seg_003"]
  }'

{
  "id": "vrs_12345",
  "name": "Example VRS (Updated)",
  "parentRsid": "examplersid",
  "segmentList": [
    "seg_001",
    "seg_003"
  ]
}

Request example details

The example above updates the virtual report suite name and segment list.

Response example details

The example above returns the updated virtual report suite.

Request Parameters

The PUT a virtual report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the PUT a virtual report suite response parameters:

DELETE a virtual report suite

Use this endpoint to delete or disable a virtual report suite by ID.

DELETE https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/{ID}

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'DELETE' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/vrs_12345" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "result": "success",
  "message": "Virtual report suite deleted"
}

Request example details

The example above deletes the virtual report suite with the ID vrs_12345.

Response example details

The example above confirms the virtual report suite was deleted.

Request Parameters

The DELETE a virtual report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the DELETE a virtual report suite response parameters:

POST validate a virtual report suite

Use this endpoint to validate a virtual report suite configuration without creating it.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/validate

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'POST' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/validate" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
    "name": "Example VRS",
    "parentRsid": "examplersid",
    "segmentList": ["seg_001", "seg_002"]
  }'

{
  "valid": true,
  "validator_version": "1.0.0",
  "message": "Configuration is valid",
  "supported_products": [
    "Analytics"
  ]
}

Request example details

The example above validates a virtual report suite configuration before creation.

Response example details

The example above indicates the configuration is valid and compatible.

Request Parameters

The POST validate a virtual report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the POST validate a virtual report suite response parameters:

POST search virtual report suites

Use this endpoint to retrieve many virtual report suites using a search body.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/search

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'POST' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/virtualreportsuites/search?limit=10&page=0" \
  -H "accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  --data "filterByIds=vrs_12345,vrs_67890&idContains=example&segmentIds=seg_001"

[
  {
    "id": "vrs_12345",
    "name": "Example VRS",
    "parentRsid": "examplersid"
  }
]

Request example details

The example above searches for virtual report suites by ID list and segment IDs.

Response example details

The example above returns a list of matching virtual report suites.

Request Parameters

The POST search virtual report suites endpoint includes the following request parameters:

Response Parameters

The following table describes the POST search virtual report suites response parameters:

GET timezones

Use this endpoint to retrieve all supported timezones.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/reportsuites/timezones

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/reportsuites/timezones" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

[
  {
    "timezoneId": 121,
    "name": "Pacific Time",
    "timezoneZoneinfo": "US/Pacific",
    "currentTimezoneOffset": -8
  }
]

Request example details

The example above requests the list of supported timezones.

Response example details

The example above returns a timezone entry with its ID and friendly name.

Request Parameters

The GET timezones endpoint includes the following request parameters:

Response Parameters

The following table describes the GET timezones response parameters:

POST a report suite

Use this endpoint to create a new standard report suite. The proposed RSID must begin with the prefix of the owning company.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/reportsuites/{RSID}

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

curl -X 'POST' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/reportsuites/reportsuites/examplersid?copySettingsFromRsid=templatesuite" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
    "name": "Example Report Suite",
    "hitsPerDay": 500000,
    "timezone": "US/Pacific",
    "signUpDate": "2024-01-01",
    "baseUrl": "example.com",
    "currencyCode": "USD"
  }'

{
  "rsid": "examplersid",
  "created": true,
  "axleActivated": true
}

Request example details

The example above creates a report suite with the ID examplersid, copying settings from templatesuite.

Response example details

The example above confirms the report suite was created.

Request Parameters

The POST a report suite endpoint includes the following request parameters:

Response Parameters

The following table describes the POST a report suite response parameters: