Data Warehouse API

The Analytics 2.0 Data Warehouse API endpoints provide methods for creating and managing Data Warehouse scheduled requests, and for viewing report data generated by those requests. The endpoints use the same data and methods that are used when working with Data Warehouse in the Adobe Analytics UI. See the Data Warehouse overview for more information.

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 for more information.

data-variant=info

data-slots=text

The Data Warehouse endpoints described in this guide do not return Analytics data content. The endpoints in this guide are strictly for managing the scheduled requests and the reports generated for those scheduled requests.

Data Warehouse scheduled requests

These endpoints provide methods for creating, viewing, managing, and updating Data Warehouse scheduled requests:

POST scheduled request: Creates a scheduled request
GET scheduled requests: Retrieves summarized scheduled requests that match specified filters
GET scheduled request by ID: Retrieves a detailed scheduled request for a specified UUID.
PUT scheduled request: Updates a scheduled request for a specified UUID

Reports for Data Warehouse scheduled requests

These endpoints provide methods for viewing, managing, and updating the reports generated from Data Warehouse scheduled requests:

GET reports: Retrieves the reports generated by a specified scheduled request
GET report by ID: Retrieves a report specified by UUID
PUT report by ID: Updates a report specified by UUID

data-variant=info

data-slots=text

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

POST scheduled request

Use this endpoint to create a scheduled request. For more information on creating scheduled requests, see Create a Data Warehouse request.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled

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

            

              Request
            

              curl -X 'POST'
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled" \
  -H "Content-Type: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
  "schedule": {
    "periodSettings": {
      "frequency": "daily"
    }, "cancelSettings": {
      "cancelMethod": "afterOccurrences",
      "endAfterNumOccurrences": 10
    }
  },
  "request": {
    "name": "Run Daily Example",
      "reportParameters": {
          "reportRange": {
              "preset": "Yesterday"
          },
          "dimensionList": [
          ],
          "metricList": [
              {
                  "id": "metrics/visitors"
              }
          ]
      },
    "rsid": "examplersid"
  },
  "delivery": {
      "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a"
      }
  }
}'

            

              Response
            

              {
  "metadata": {
    "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
    "scheduledRequestLegacyID": 00000001,
    "status": "Scheduled",
    "createdDate": "YYYY-MM-DDT00:00:00Z",
    "updatedDate": "YYYY-MM-DDT00:00:00Z",
    "jobType": "Data Warehouse",
    "ownerInfo": {
      "company": "Example Org",
      "login": "example_user@adobe.com",
      "imsUserId": "000000000000000000000000@0000000000000000000000.e",
      "email": "example_user@adobe.com",
      "phone": null
    }
  },
  "schedule": {
    "scheduleAt": "YYYY-MM-DDT00:00:00Z",
    "periodSettings": {
      "frequency": "daily",
      "every": 1,
      "dayOfMonth": null,
      "dayOfWeek": null,
      "month": null,
      "weekOfMonth": null
    },
    "cancelSettings": {
      "cancelMethod": "afterOccurrences",
      "cancelDate": null,
      "endAfterNumOccurrences": 10
    }
  },
  "request": {
    "name": "Run Daily Example",
    "sharing": {
      "shareWithOtherUsers": false
    },
    "outputFile": {
      "compressionFormat": "default",
      "outputFileBasename": "Report",
      "fileFormat": "csv",
      "sendEmptyFileForNoDataReport": false,
      "beginningOfReportComments": "",
      "sendDigitalSignatureFile": false,
      "sendManifestFile": false
    },
    "reportParameters": {
      "dimensionList": [],
      "metricList": [
        {
          "namespace": "Identity Service",
          "id": "metrics/visitors",
          "properties": null
        }
      ],
      "segmentList": [],
      "dateGranularity": "none",
      "numberOfRowsInTable": null,
      "reportRange": {
        "preset": "Yesterday",
        "startDateTime": null,
        "endDateTime": null
      },
      "sortByMetrics": false
    },
    "rsid": "examplersid"
  },
  "delivery": {
    "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a",
    "email": null,
    "legacyEmail": null,
    "legacyAzure": null,
    "legacyFTP": null,
    "legacyS3": null
  }
}

            

Request Example Details

The example above creates a scheduled request with the following details:

The name of the request is Run Daily Example and it references the examplersid report suite.
It generates a daily report of the data for the previous day.
It will stop generating a report after 10 occurrences.

Response Example Details

The successful JSON response example above confirms the following details:

The name of the request is Run Daily Example and it references the examplersid report suite.
It generates a daily report of the data for the previous day.
It will stop generating a report after 10 occurrences.

Request parameters

The following table describes request parameters for creating a scheduled request:

Name

Req/Opt

Type

Description

schedule

required

container

Contains parameters detailing the scheduled request, including scheduleAt, periodSettings, and cancelSettings parameters.

scheduleAt

optional

string

Timestamp of when the request is scheduled. Must align with an hour boundary in the report suite timezone

periodSettings

required

container

The settings for the frequency of delivery. Contains the frequency, every, dayOfMonth, dayOfWeek, month, and weekOfMonth parameters.

frequency

optional

string

How often the report is to be generated, e.g. daily

every

optional

integer

The number associated with the frequency

dayOfMonth

optional

integer

The day of the month

dayOfWeek

optional

string

The day of the week

month

optional

string

The month

weekOfMonth

optional

string

The week of the month

cancelSettings

optional

container

The settings for cancelling the scheduled request. Contains the cancelMethod, cancelDate, and endAfterNumOccurrences parameters.

cancelMethod

optional

string

cancelDate

optional

string

The date on which the scheduled request will be cancelled

endAfterNumOccurrences

optional

integer

The number of times a report is to be generated before the scheduled request is cancelled

request

required

container

The details of what the scheduled request will generate. Contains the name, sharing, outputFile, reportParameters, and rsid parameters.

name

required

string

The name of the scheduled request

sharing

optional

container

Whether the scheduled request will be shared with others. Contains the shareWithOtherUsers parameter.

shareWithOtherUsers

optional

boolean

Whether the scheduled request will be shared with others.

outputFile

optional

container

The options for the output file of the scheduled request. Contains the compressionFormat, outputFileBasename, fileFormat, sendEmptyFileForNoDataReport, beginningOfReportComments, sendDigitalSignatureFile, and sendManifestFile parameters.

compressionFormat

optional

string

The compression format used on the output file. Valid values are: default, zip, and gzip.

outputFileBasename

optional

string

The base name of the output file

fileFormat

optional

string

The file format used for the output file

sendEmptyFileForNoDataReport

optional

boolean

Whether an empty file should be sent if there is no data in the report

beginningOfReportComments

optional

string

Comments to be displayed at the top of the report

sendDigitalSignatureFile

boolean

Whether a digital signature file is sent with the output file. This allows recipients to verify the report came from Adobe and that it has not been altered.

sendManifestFile

optional

boolean

Whether a manifest file is sent with the output file. This file contains metadata about the other files included in the report.

reportParameters

required

container

The parameters of the reports to be generated by the scheduled request. Contains the dimensionList, metricList, segmentList, dateGranularity, numberOfRowsInTable, reportRange, and sortByMetrics parameters

dimensionList

required

array

What dimensions will be included in the report. Contains the namespace, id, and properties parameters.

namespace

optional

string

The namespace of a segment service value. This parameter must be used in conjunction with a segment service ID in the id parameter. This parameter is to not be included if you are using an identity service name for your dimension.

id

required

string

The ID of the dimension to be included. The IDs of dimensionList items are either identity service names or a segment service ID. Note that when a namespace value is not included, the service will infer the id value as an identity service name.

properties

optional

object

Contains the properties used to augment what is included in the report

metricList

required

array

The metrics to be included in the report. Contains the namespace, id, and properties parameters.

id

string

The ID of the metrics to be included. The IDs of metricList items are identity service names.

properties

optional

object

Contains the properties used to augment what is included in the report

segmentList

optional

array

The segments to be included in the report. Contains the namespace, id, and properties parameters.

namespace

optional

string

The segment service name of the segments to be included

id

required

string

The ID of the segment to be included

properties

optional

object

Contains the properties used to augment what is included in the report

dateGranularity

optional

string

The date granularity of the report to be generated

numberOfRowsInTable

optional

integer

The number of rows to be generated per table

reportRange

required

container

The time-range to be included in the report. Contains the preset, startDateTime, and endDateTime parameters.

preset

optional

string

A preset to use for the time-range of the report

startDateTime

optional

string

The starting datetime for the range of the report

endDateTime

optional

string

The ending datetime for the range of the report

sortByMetrics

optional

boolean

Whether the report is sorted by metrics

rsid

required

string

The report suite ID

delivery

required

container

Settings for report delivery. Contains the exportLocationUUID and email parameters. If the exportLocationUUID includes an email in its inherent configuration, do not include the email parameter. For more information about delivery options see the Data Warehouse Delivery Guide.

exportLocationUUID

required

string

The UUID of the export location. You can retrieve this value with the GET scheduled request by ID endpoint.

email

optional

container

The settings regarding email notification. Do not use if the exportLocationUUID includes an email delivery in its inherent configuration. Contains the notificationEmailTo, notificationEmailFrom, notificationEmailSubject, and notificationEmailNotes parameters.

notificationEmailTo

optional

string

The notification email destination

notificationEmailFrom

optional

string

The origin of the email

notificationEmailSubject

optional

string

The subject line of the notification email

notificationEmailNotes

optional

string

Notes for email notification

Response Parameters

The response parameters for creating a scheduled request include those described in the previous table of request parameters, with the following additional parameters:

Name

Type

Description

legacyEmail

boolean

Whether the legacy email system is used

legacyAzure

container

The details associated with Azure delivery. Contains the account, container, and prefix parameters.

account

string

The account associated with delivery

container

string

The container associated with delivery

prefix

string

The container prefix

legacyFTP

container

The details associated with FTP delivery. Contains the username, host, port, and directory parameters.

username

string

The username to log into the FTP site

host

string

The desired FTP destination URL

port

integer

The port

directory

string

The path to the location on the FTP account

legacyS3

container

The details associated with S3 delivery. Contains the awsBucket, awsAccessKey, and awsPath parameters.

awsBucket

string

The name of the bucket

awsAccessKey

string

The access key for the delivery location

awsPath

string

The path to the intended location

metadata

container

The metadata of the scheduled request. Contains the scheduledRequestUUID, scheduledRequestLegacyID, status, createdDate, updatedDate, and ownerInfo parameters.

scheduledRequestUUID

string

The UUID of the scheduled request

scheduledRequestLegacyID

integer

The legacy ID of the scheduled request

status

string

The status of the scheduled request. Possible values are: Scheduled, Completed, Canceled, and Error.

createdDate

string

The date the scheduled request was created

updatedDate

string

The most recent date the scheduled request was updated

ownerInfo

container

The information of the owner of the scheduled request. Contains the company, login, imsUserId, email. and phone parameters.

company

string

The company of the owner of the scheduled request

login

string

The login of the owner of the scheduled request

imsUserId

string

The IMS User ID of the owner of the scheduled request

email

string

The email address of the owner for the scheduled request

phone

string

The phone number of the owner of the scheduled request

GET scheduled requests

Use this endpoint to retrieve a filtered list of scheduled requests.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled

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

            

              Request
            

              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled?rsid=examplersid" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              {
  "total": 2,
  "totalReturned": 2,
  "scheduledRequests": [
    {
      "mostRecentReport": {
        "metadata": {
          "legacyReportID": 00000000,
          "uuid": "00000000-0000-0000-0000-000000000000",
          "status": "Processing"
        }
      },
      "request": {
        "name": "Second request example",
        "rsid": "examplersid"
      },
      "metadata": {
        "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
        "scheduledRequestLegacyID": 00000001,
        "status": "Completed",
        "createdDate": "YYYY-MM-DDT00:00:00Z",
        "updatedDate": "YYYY-MM-DDT00:00:00Z",
        "ownerInfo": {
          "login": "example_user@adobe.com",
          "imsUserId": "000000000000000000000000@0000000000000000000000.e"
        }
      }
    },
    {
      "mostRecentReport": {
        "metadata": {
          "legacyReportID": 00000000,
          "uuid": "00000000-0000-0000-0000-000000000000",
          "status": "Completed"
        }
      },
      "request": {
        "name": "Exampledwrequest",
        "rsid": "examplersid"
      },
      "metadata": {
        "scheduledRequestUUID": "44444444-3333-2222-1111-000000000002",
        "scheduledRequestLegacyID": 00000001,
        "status": "Completed",
        "createdDate": "YYYY-MM-DDT00:00:00Z",
        "updatedDate": "YYYY-MM-DDT00:00:00Z",
        "ownerInfo": {
          "login": "example_user@adobe.com",
          "imsUserId": "000000000000000000000000@0000000000000000000000.e"
        }
      }
    }
  ]
}

            

Request Example Details

The example above shows a request for a summarized list Data Warehouse scheduled requests associated with the report suite ID examplersid.

Response Example Details

The successful JSON response example above shows the following details:

Two scheduled requests are associated with the examplersid report suite: Exampledwrequest and Second request example.
The status of Exampldwrequest is Completed and the status of Second request example is Processing.
The owner and login associated with these requests is example_user@adobe.com.

Request parameters

The following table describes the request parameters for GET scheduled requests:

Name

Required

Type

Description

rsid

required

string

The report suite ID

createdAfter

optional

string

Filters for requests created on or after the specified datetime

createdBefore

optional

string

Filters for requests created on or before the specified datetime

updatedAfter

optional

string

Filters for requests updated on or after the specified datetime

updatedBefore

optional

string

Filters for requests updated on or before the specified datetime

status

optional

string

Filters for requests based on status. Valid values are: Scheduled, Completed, Canceled, and Error.

sort

optional

string

Determines the order of returned reports. This parameter must be two values separated by a colon. The first value must be either createdDate or updatedDate. The second value must be either asc or desc. An example pair would be createdDate:asc.

limit

optional

integer

Max number of requests that will be returned

Response Parameters

The following table describes the response parameters for GET scheduled requests:

Name

Type

Description

total

integer

The total number of scheduled requests

totalReturned

integer

The total number of scheduled requests retuned

scheduledRequests

array

An array that contains all of the information regarding the returned scheduled requests. Contains the mostRecentReport, request, and metadata parameters.

mostRecentReport

container

The metadata of the most recent report generated by the scheduled request. Contains the metadata parameter.

metadata

container

The metadata associated with the report. Contains the legacyReportID, uuid, and status parameters.

legacyReportID

integer

The legacy report ID of the report

uuid

string

The UUID of the report

status

string

The status of the report delivery. Possible statuses are: Created, Pending, Processing, Completed, Scheduled, Canceled, Error - Processing, and Error - Failure To Send.

request

container

The name and RSID of the scheduled request. Contains the name and rsid parameters

name

string

The name of the scheduled request

rsid

string

The RSID of the request

metadata

container

The metadata of the scheduled request. Contains the scheduledRequestUUID, scheduledRequestLegacyID, status, createdDate, updatedDate, and ownerInfo parameters.

scheduledRequestUUID

string

The UUID of the scheduled request

scheduledRequestLegacyID

integer

The legacy ID of the scheduled request

status

string

The status of the scheduled request. Possible values are: Scheduled, Completed, Canceled, and Error.

createdDate

string

The date the scheduled request was created

updatedDate

string

The most recent date the scheduled request was updated

ownerInfo

container

The information of the owner of the scheduled request. Contains the login and imsUserId parameters.

login

string

The login of the owner of the scheduled request

imsUserId

string

The IMS User ID of the owner of the request

GET scheduled request by ID

Use this endpoint to retrieve a specific scheduled request using its associated UUID. This endpoint also returns the exportLocationUUID, which is a required parameter for creating a scheduled request.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled/{UUID}

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

            

              Request
            

              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GlOBAL_COMPANY_ID}/data_warehouse/scheduled/44444444-3333-2222-1111-000000000000" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              {
  "metadata": {
    "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
    "scheduledRequestLegacyID": 00000000,
    "status": "Completed",
    "createdDate": "YYYY-MM-DDT00:00:00Z",
    "updatedDate": "YYYY-MM-DDT00:00:00Z",
    "jobType": "Data Warehouse",
    "ownerInfo": {
      "company": "Example Org",
      "login": "example_user@adobe.com",
      "imsUserId": "000000000000000000000000@0000000000000000000000.e",
      "email": "example_user@adobe.com",
      "phone": null
    }
  },
  "schedule": {
    "scheduleAt": "YYYY-MM-DDT00:00:00Z",
    "periodSettings": {
      "frequency": "daily",
      "every": 1,
      "dayOfMonth": null,
      "dayOfWeek": null,
      "month": null,
      "weekOfMonth": null
    },
    "cancelSettings": {
      "cancelMethod": "afterOccurrences",
      "cancelDate": null,
      "endAfterNumOccurrences": 1
    }
  },
  "request": {
    "name": "Second request example",
    "sharing": {
      "shareWithOtherUsers": true
    },
    "outputFile": {
      "compressionFormat": "default",
      "outputFileBasename": "Report",
      "fileFormat": "csv",
      "sendEmptyFileForNoDataReport": true,
      "beginningOfReportComments": "",
      "sendDigitalSignatureFile": false,
      "sendManifestFile": false
    },
    "reportParameters": {
      "dimensionList": [
        {
          "namespace": "Identity Service",
          "id": "variables/browser",
          "properties": null
        }
      ],
      "metricList": [
        {
          "namespace": "Identity Service",
          "id": "metrics/cartviews",
          "properties": null
        }
      ],
      "segmentList": [
        {
          "namespace": "Segment Service",
          "id": "s000000000_0000000000000000000000ea",
          "properties": null
        }
      ],
      "dateGranularity": "daily",
      "numberOfRowsInTable": null,
      "reportRange": {
        "preset": "Last month",
        "startDateTime": null,
        "endDateTime": null
      },
      "sortByMetrics": false
    },
    "rsid": "examplersid"
  },
  "delivery": {
    "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a",
    "email": null,
    "legacyEmail": null,
    "legacyAzure": null,
    "legacyFTP": null,
    "legacyS3": null
  }
}

            

Request Example Details

The example above requests the information associated with scheduledRequestUUID: 44444444-3333-2222-1111-000000000000.

Response Example Details

The JSON response example above shows the following details:

The name of the scheduled request associated with the scheduledrequestUUID 44444444-3333-2222-1111-000000000000 is Second request example.
The exportLocationUUID of the Second request example is 000fxf00-12d1-1234-a6aa-00000000000a. This ID can be used to create additional schedule requests with the POST scheduled request method.

Request parameters

The following table describes the GET scheduled request by ID request parameters:

Name

Required

Type

Description

UUID

required

string

The scheduled request UUID

Response Parameters

The GET scheduled request by ID endpoint uses the same response parameters as those described in the tables above.

PUT scheduled request

Use this endpoint to update a scheduled request.

PUT https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/scheduled/{UUID}

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

            

              Request
            

              curl -X 'PUT' \
  "https://analytics.adobe.io/api/{GlOBAL_COMPANY_ID}/data_warehouse/scheduled/44444444-3333-2222-1111-000000000000" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"
  -d '{
  "request": {
    "name": "New example report name",
    "sharing": {
      "shareWithOtherUsers": true
    },
    "reportParameters": {
      "numberOfRowsInTable": 50
    }
  }
}'

            

              Response
            

               {
  "metadata": {
    "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
    "scheduledRequestLegacyID": 0000001,
    "status": "Scheduled",
    "createdDate": "YYYY-01-25T18:23:33Z",
    "updatedDate": "YYYY-04-03T20:34:07Z",
    "jobType": "Data Warehouse",
    "ownerInfo": {
      "company": "Example org",
      "login": "example_user@example.com",
      "imsUserId": "dw-rest-api@AdobeID",
      "email": "example_user@example.com",
      "phone": null
    }
  },
  "schedule": {
    "scheduleAt": "YYYY-05-06T02:00:00Z",
    "periodSettings": {
      "frequency": "monthlyByWeek",
      "every": 1,
      "dayOfMonth": null,
      "dayOfWeek": "Monday",
      "month": null,
      "weekOfMonth": "first"
    },
    "cancelSettings": {
      "cancelMethod": "never",
      "cancelDate": null,
      "endAfterNumOccurrences": null
    }
  },
  "request": {
    "name": "New report name",
    "sharing": {
      "shareWithOtherUsers": true
    },
    "outputFile": {
      "compressionFormat": "default",
      "outputFileBasename": "Report",
      "fileFormat": "csv",
      "sendEmptyFileForNoDataReport": false,
      "beginningOfReportComments": "",
      "sendDigitalSignatureFile": false,
      "sendManifestFile": false
    },
    "reportParameters": {
      "dimensionList": [],
      "metricList": [
        {
          "namespace": "Identity Service",
          "id": "metrics/visitors",
          "properties": null
        }
      ],
      "segmentList": [],
      "dateGranularity": "none",
      "numberOfRowsInTable": 50,
      "reportRange": {
        "preset": "Today",
        "startDateTime": null,
        "endDateTime": null
      },
      "sortByMetrics": false
    },
    "rsid": "examplersid"
  },
  "delivery": {
    "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a",
    "email": null,
    "legacyEmail": null,
    "legacyAzure": null,
    "legacyFTP": null,
    "legacyS3": null
  }
}

            

Request Example Details

The example above requests the following updates for the scheduled request:

Renaming to "New example report name"
Sharing is enabled with other users
Specifies 50 as the number of rows in tables

Response Example Details

The example response confirms that each of the three values specified in the request have been updated. Additionally, it also shows the date it was updated after its creation. Note the following lines:

"createdDate": "YYYY-01-25T18:23:33Z",
"updatedDate": "YYYY-04-03T20:34:07Z",

Request parameters

The PUT scheduled request endpoint uses the same request parameters as those described in the tables above.

Response Parameters

The GET scheduled request by ID endpoint uses the same response parameters as those described in the tables above.

GET reports

Use this endpoint to retrieve a list of reports generated by specified scheduled requests. Note that this will not return the data reports themselves, but only associated metadata with the scheduled requests.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/report

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

            

              Request
            

              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GlOBAL_COMPANY_ID}/data_warehouse/report?scheduledRequestUUID=44444444-3333-2222-1111-000000000000" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              {
  "total": 1,
  "totalReturned": 1,
  "reportList": [
    {
      "metadata": {
        "legacyReportID": 000000001,
        "reportUUID": "99999999-8888-7777-6666-555555555555",
        "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
        "createdDate": "YYYY-MM-DDT00:00:00Z",
        "updatedDate": "YYYY-MM-DDT00:00:00Z",
        "startedDate": "YYYY-MM-DDT00:00:00Z",
        "completedDate": "YYYY-MM-DDT00:00:00Z",
        "status": "Completed",
        "currentTask": ""
      },
      "report": {
        "fromDate": "YYYY-MM-DDT00:00:00Z",
        "toDate": "YYYY-MM-DDT00:00:00Z"
      }
    }
  ]
}

            

Request Example Details

The example above requests a list of reports associated with scheduledRequestUUID: 44444444-3333-2222-1111-000000000000.

Response Example Details

The example above shows a list of reports associated with scheduledRequestUUID: 44444444-3333-2222-1111-000000000000. The response lists only one report with areportUUIID of 99999999-8888-7777-6666-555555555555.

Request parameters

The following table describes the request parameters:

Name

Required

Type

Description

scheduledRequestUUID

required

string

The ID for a data warehouse scheduled request

createdAfter

optional

string

Filters for reports created on or after the specified datetime

createdBefore

optional

string

Filters for reports created on or before the specified datetime

updatedAfter

optional

string

Filters for reports updated on or after the specified datetime

updatedBefore

optional

string

Filters for reports updated on or before the specified datetime

status

optional

string

A comma-delimited list that filters for reports based on specified status. Enums: Completed, Canceled, Error - Failure To Send, Error - Processing, Created, Processing, Pending.

sort

optional

string

limit

optional

integer

The maximum number of reports that will be returned

Response Parameters

The following table describes the reports response parameters:

Name

Type

Description

total

integer

The total number of reports associated with the scheduled request

totalReturned

integer

The total number of returned reports

reportList

array

An array that contains the data regarding all the returned reports. Contains the metadata and report parameters.

metadata

container

The metadata associated with the report. Contains the legacyReportID, uuid, and status parameters.

legacyReportID

integer

The legacy report ID

reportUUID

string

The report ID or UUID

status

string

The satus of the report delivery. Possible statuses are: Created, Pending, Processing, Completed, Scheduled, Canceled, Error - Processing, and Error - Failure To Send.

report

container

The date range the report covers. Contains the fromDate and toDate parameters.

fromDate

string

The start date of the date range included in the report

toDate

string

The end date of the date range included in the report

GET report by ID

Use this endpoint to retrieve a report by its UUID. Note that the Report UUID is not the same as the scheduled request UUID. This report does not include analytics data, but only the metadata associated with the scheduled request.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/report/{REPORT_UUID}

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

            

              Request
            

              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GlOBAL_COMPANY_ID}/data_warehouse/report?reportUUID=99999999-8888-7777-6666-555555555555" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              {
  "delivery": {
    "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a",
    "email": {
      "notificationEmailTo": "notification_email_in_delivery_profile",
      "notificationEmailFrom": "no-reply@example.com",
      "notificationEmailSubject": "Data Warehouse: for examplersid",
      "notificationEmailNotes": null
    },
    "legacyEmail": null,
    "legacyAzure": null,
    "legacyFTP": null,
    "legacyS3": null
  },
  "outputFile": {
    "compressionFormat": "default",
    "outputFileBasename": "Report",
    "fileFormat": "csv",
    "sendEmptyFileForNoDataReport": true,
    "beginningOfReportComments": "",
    "sendDigitalSignatureFile": null,
    "sendManifestFile": null
  },
  "metadata": {
    "legacyReportID": 000000001,
    "reportUUID": "99999999-8888-7777-6666-555555555555",
    "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
    "createdDate": "YYYY-MM-DDT00:00:00Z",
    "updatedDate": "YYYY-MM-DDT00:00:00Z",
    "startedDate": "YYYY-MM-DDT00:00:00Z",
    "completedDate": "YYYY-MM-DDT00:00:00Z",
    "status": "Completed",
    "currentTask": "",
    "jobType": "Data Warehouse"
  },
  "report": {
    "rsid": "examplersid",
    "fromDate": "YYYY-MM-DDT00:00:00Z",
    "toDate": "YYYY-MM-DDT00:00:00Z"
  }
}

            

Request example details

The example above requests a detailed report associated with the Report UUID 99999999-8888-7777-6666-555555555555.

Response example details

The example above shows a response with details for the requested report, including the exportLocationUUID, email notifications, the output file, the relevant schedule timestamps and schedule request identifiers.

Request parameters

The GET report by ID endpoint uses the same request parameters as those described in the tables above.

Response Parameters

The GET report by ID endpoint uses the same response parameters as those described in the tables above.

PUT report by ID

Use this endpoint to update a specified report by the Report UUID.

PUT https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/data_warehouse/report/{REPORT_UUID}

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

            

              Request
            

              curl -X 'PUT' \
  "https://analytics.adobe.io/api/{GlOBAL_COMPANY_ID}/data_warehouse/report/44444444-3333-2222-1111-000000000000" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"
  -d '{
  "metadata": {
    "status": "resend"
  }
}'

            

              Response
            

              {
  "delivery": {
    "exportLocationUUID": "000fxf00-12d1-1234-a6aa-00000000000a",
    "email": {
      "notificationEmailTo": "notification_email_in_delivery_profile",
      "notificationEmailFrom": "example_user@example.com",
      "notificationEmailSubject": "Data Warehouse: for examplersid",
      "notificationEmailNotes": null
    },
    "legacyEmail": null,
    "legacyAzure": null,
    "legacyFTP": null,
    "legacyS3": null
  },
  "outputFile": {
    "compressionFormat": "default",
    "outputFileBasename": "Report",
    "fileFormat": "csv",
    "sendEmptyFileForNoDataReport": true,
    "beginningOfReportComments": "",
    "sendDigitalSignatureFile": null,
    "sendManifestFile": null
  },
  "metadata": {
    "legacyReportID": 0000001,
    "reportUUID": "99999999-8888-7777-6666-555555555555",
    "scheduledRequestUUID": "44444444-3333-2222-1111-000000000000",
    "createdDate": "YYYY-MM-DDT00:00:00Z",
    "updatedDate": "YYYY-MM-DDT00:00:00Z",
    "startedDate": "YYYY-MM-DDT00:00:00Z",
    "completedDate": "YYYY-MM-DDT00:00:00Z",
    "status": "Processing",
    "currentTask": "",
    "jobType": "Data Warehouse"
  },
  "report": {
    "rsid": "examplersid",
    "fromDate": "YYYY-MM-DDT00:00:00Z",
    "toDate": "YYYY-MM-DDT00:00:00Z"
  }
}

            

Request Example Details

The example above requests a resend in the status of the metadata object.

Response Example Details

The response example above shows that the status in the metadata object has been updated from Complete to Processing.

Request parameters

The PUT report by ID endpoint uses the same request parameters as those described in the tables above.

Response Parameters

The PUT report by ID endpoint uses the same response parameters as those described in the tables above.

For more information, or for trouble-shooting help, see the following: