Analytics Classifications API

The Analytics 2.0 Classifications API endpoints provide advanced methods for categorizing variable data and displaying it in reports. The endpoints use the same data and methods that are used when working with classifications in the Adobe Analytics UI. See the Classifications overview for more information.

Adobe Analtyics Classifications APIs do not create classification datasets (or, sometimes called "classification sets"). To create classification datasets in the UI that work with these Classifications APIs, see Classifications overview.

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.

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.

This guide includes instructions for using the following endpoints:

Classification Jobs

POST import JSON classification: Creates a classification from a JSON payload
POST export classification: Creates an export job for a specified dataset ID
GET export classification file: Retrieves the output of an export
GET classification job file partition list: Retrieves a list of classification file parts
GET classification export job file part: Retrieves a part of a classification file
GET classification template: Retrieves a template showing structure of exported data
GET all classification datasets: Retrieves all datasets for a specified report suite ID
GET a single classification: Retrieves information for the specified dataset
GET classification job information: Retrieves job information for the specified job ID
GET classification jobs by dataset: Retrieves job information for the specified dataset
PUT classification dataset update: Updates a classification dataset
DELETE classification: Deletes a specified classification

Importing classification datasets

This guide includes instructions for importing JSON classification datasets smaller than 50 MB. With this method, you include the dataset in the payload as part of a POST request. To import classification datasets that are larger than 50 MB, or that include a .tsv or .tab file, see Importing classifications by file upload.

POST import JSON classification

This endpoint is shown in the API reference as POST /job/import/json/{dataset_id}.

Use this endpoint to create a classification smaller than 50 MB. For more information on importing classifications, see Classifications importer overview.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/import/json/{DATASET_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.

Request

Response

curl -X POST "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/import/json/{DATASET_ID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}" \
     -d '{
          "dataFormat": "json",
          "encoding": "UTF8",
          "jobName": "example_dataset_name-example-dataset_id at example_time",
          "notifications": [
            {
              "method": "email",
              "state": "completed",
              "recipients": [
                "john@example.com"
              ]
            }
          ],
          "listDelimiter": ",",
          "source": "Direct API Upload",
          "keyOptions": {
            "byte_length": 0,
            "type": "string"
          },
          "data": [
            {
              "key": "KeyYYYY0730-json1",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-4"
              }
            },
            {
              "key": "KeyYYYY0730-json2",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-5"
              }
            },
            {
              "key": "KeyYYYY0730-json3",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-6"
              }
            }
          ]
        }'
Copied to your clipboard
curl -X POST "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/import/json/{DATASET_ID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}" \
     -d '{
          "dataFormat": "json",
          "encoding": "UTF8",
          "jobName": "example_dataset_name-example-dataset_id at example_time",
          "notifications": [
            {
              "method": "email",
              "state": "completed",
              "recipients": [
                "john@example.com"
              ]
            }
          ],
          "listDelimiter": ",",
          "source": "Direct API Upload",
          "keyOptions": {
            "byte_length": 0,
            "type": "string"
          },
          "data": [
            {
              "key": "KeyYYYY0730-json1",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-4"
              }
            },
            {
              "key": "KeyYYYY0730-json2",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-5"
              }
            },
            {
              "key": "KeyYYYY0730-json3",
              "data": {
                "Product Brand": "Basket Ball Jam",
                "Category": "",
                "Size": "Winter Fun",
                "Weight": "Sports",
                "Origin": "Origin-6"
              }
            }
          ]
        }'

{
  "import_job_id": "91f38377-b674-4230-9459-e2219cae3e9c",
  "api_job_id": "5e116b45-32a8-4978-b123-4b0ce0eceab1"
}
Copied to your clipboard
{
  "import_job_id": "91f38377-b674-4230-9459-e2219cae3e9c",
  "api_job_id": "5e116b45-32a8-4978-b123-4b0ce0eceab1"
}

Request example details

The example above requests the following:

The dataFormat for the classification as json.
The jobName as example_dataset_name-example-dataset_id at example_time.
The notifications to be sent by email when the status is completed.
The import data is comma delimited with key value pairs for key, data, Category, Weight, and Origin.

Response example details

The response example above shows import_job_id and api_job_id values that can be used with other classification endpoints.

Request parameters

The following table describes the POST import JSON classification request parameters:

Name	Required	Type	Description
`dataset_id`	required	string	The dataset ID for creating API import job
`dataFormat`	required	string	The data format option for this endpoint is `json`.
`encoding`	optional	string	The encoding for data. The default value is `UTF-8`.
`jobName`	optional	string	The name of the job
`notifications`	optional	container	Contains the notification information. Includes the `method`, `state`, and `recipients` parameters.
`method`	optional	string	The method by which the notification is sent. This includes the enums `email` and `rabbit`.
`state`	optional	string	The state of the notification. Includes the following enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, and `completed`.
`recipients`	optional	string	The recipients of the notification
`listDelimiter`	optional	string	Specifies the data delimiter for the list. Default delimiter is `,` (comma)
`keyOptions`	optional	container	Contains the `byte_length`, `type`, and `overwrite` parameters
`byte_length`	optional	integer	The byte length of the job
`type`	optional	string	The type of the job
`overwrite`	optional	boolean	Whether or not the import will overwrite.
`data`	required		The data to be imported
`jobImportOption`	optional	container	Contains the `dataFormat`, `encoding`, `jobName`, `notifications`,`listDelimeter`, `source`, `keyOptions`, and `notification_extras` parameters. As described in the following 12 rows.
`dataFormat`	optional	string	The data format options. Includes `tsv`, `tab`, or `json`.
`encoding`	optional	string	The encoding for data. The default value is `UTF-8`.
`jobName`	optional	string	The name of the job
`listDelimiter`	optional	string	Specifies the data delimiter for the list. Default delimiter is `,` (comma)
`source`	optional	string	The data source. Default value is `"Direct API Upload"`.
`overwrite`	optional	boolean	Whether or not the import will overwrite.
`notification_extras`	optional	container	Extra options for notifications. Contains the `key`, and `value` parameters.
`key`	optional	string	The field or column name associated with key value
`value`	optional	string	The actual value of the key (as in a field or column name)

Response Parameters

No response parameters are returned. Successful requests are indicated by a 200 status code.

POST export classification

This endpoint is shown in the API reference as POST /job/export/{dataset_id}.

Use this endpoint to create an export job for a classification dataset. The dataset can be retrieved in a subsequent request by providing the job ID returned with this endpoint.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/{DATASET_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.

Request

Response

curl -X POST 'https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/{DATASET_ID}' \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}" \
     -d '{
          "dataFormat": "json",
          "encoding": "UTF8",
          "jobName": "example_dataset_name-example-dataset_id at example_time",
          "notifications": [
            {
              "method": "email",
              "state": "failed_validation",
              "recipients": [
                "john@example.com"
              ]
            },
            {
              "method": "email",
              "state": "completed",
              "recipients": [
                "john@example.com"
              ]
            },
          ],
          "listDelimiter": ",",
          "source": "Direct API Upload",
          "rowLimit": 50000,
          "columns": [
            "string"
          ],
          "keys": [
            "string"
          ],
          "keyRegex": "string",
          "exactMatch": {},
          "regexMatch": {},
          "dateFilterStart": "YYYY-12-07T22:29:07.446Z",
          "dateFilterEnd": "YYYY-12-07T22:29:07.446Z"
        }'
Copied to your clipboard
curl -X POST 'https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/{DATASET_ID}' \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}" \
     -d '{
          "dataFormat": "json",
          "encoding": "UTF8",
          "jobName": "example_dataset_name-example-dataset_id at example_time",
          "notifications": [
            {
              "method": "email",
              "state": "failed_validation",
              "recipients": [
                "john@example.com"
              ]
            },
            {
              "method": "email",
              "state": "completed",
              "recipients": [
                "john@example.com"
              ]
            },
          ],
          "listDelimiter": ",",
          "source": "Direct API Upload",
          "rowLimit": 50000,
          "columns": [
            "string"
          ],
          "keys": [
            "string"
          ],
          "keyRegex": "string",
          "exactMatch": {},
          "regexMatch": {},
          "dateFilterStart": "YYYY-12-07T22:29:07.446Z",
          "dateFilterEnd": "YYYY-12-07T22:29:07.446Z"
        }'

{
  "datasetId": "6449b63563c1e069c6159415",
  "history": [
    {
      "timestamp": "YYYY-08-08 20:35:39",
      "jobState": "created",
      "message": "Created export job via API"
    },
    {
      "timestamp": "YYYY-08-08 20:35:39",
      "jobState": "queued",
      "message": "Job queued and ready for processing."
    }
  ],
  "imsOrgId": "0DFE76D95967D5B50A494010@AdobeOrg",
  "jobOptions": {
    "dataFormat": "tsv",
    "encoding": "utf8",
    "listDelimiter": ",",
    "rowLimit": 50000,
    "dateFilterStart": "YYYY-05-01T22:29:07Z",
    "dateFilterEnd": "YYYY-08-08T14:35:38Z",
    "notifications": [
      {
        "method": "email",
        "state": "failed_validation",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "completed",
        "recipients": [
          "john@example.com"
        ]
      },
    ]
  },
  "jobId": "16e38fbc-fc82-4fdf-88de-ec33e63489d5",
  "jobSize": -1,
  "name": "example_dataset_name-example-dataset_id at example_time",
  "setName": "example_name",
  "state": "queued",
  "totalLines": -1,
  "noeffectLines": null,
  "type": "export"
}
Copied to your clipboard
{
  "datasetId": "6449b63563c1e069c6159415",
  "history": [
    {
      "timestamp": "YYYY-08-08 20:35:39",
      "jobState": "created",
      "message": "Created export job via API"
    },
    {
      "timestamp": "YYYY-08-08 20:35:39",
      "jobState": "queued",
      "message": "Job queued and ready for processing."
    }
  ],
  "imsOrgId": "0DFE76D95967D5B50A494010@AdobeOrg",
  "jobOptions": {
    "dataFormat": "tsv",
    "encoding": "utf8",
    "listDelimiter": ",",
    "rowLimit": 50000,
    "dateFilterStart": "YYYY-05-01T22:29:07Z",
    "dateFilterEnd": "YYYY-08-08T14:35:38Z",
    "notifications": [
      {
        "method": "email",
        "state": "failed_validation",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "completed",
        "recipients": [
          "john@example.com"
        ]
      },
    ]
  },
  "jobId": "16e38fbc-fc82-4fdf-88de-ec33e63489d5",
  "jobSize": -1,
  "name": "example_dataset_name-example-dataset_id at example_time",
  "setName": "example_name",
  "state": "queued",
  "totalLines": -1,
  "noeffectLines": null,
  "type": "export"
}

Request example details

The example request above specifies the following export job options:

The dataFormat for the classification as json.
The jobName to be example_dataset_name-example-dataset_id at example_time.
The notificationsto be delivered by email to john@example.com when the state is failed_validation and completed.
The data source is "Direct API Upload".
The rowLimit to be 50000.
The dateFilterStart and dateFilterEnd are set to YYYY-12-07T22:29:07.446Z and YYYY-12-07T22:29:07.446Z.

Response example details

The response above shows the following information for the export job:

The datasetID of the job is 6449b63563c1e069c6159415.
The jobID of the job is 16e38fbc-fc82-4fdf-88de-ec33e63489d5.
The name of the job is example_dataset_name-example-dataset_id at example_time.
The classification setName of the job is example_name.
The job type is export.

Request Parameters

The following table describes the POST export classification request parameters:

Name	Required	Type	Description
`dataset_id`	required	string	The dataset ID for creating an API export job
`dataFormat`	optional	string	The data format options. Includes `tsv`, `tab`, or `json`.
`encoding`	optional	string	The encoding for data. The default value is `UTF-8`.
`jobName`	optional	string	The name of the job
`listDelimiter`	optional	string	Specifies the data delimiter for the list. Default delimiter is `,` (comma)
`rowLimit`	optional	integer	The limit of included rows. The maximum value is 1,000,000. The default value is 100,000.
`columns`	optional	string	The included columns
`keys`	optional	string	The field or column name associated with key value
`keyRegex`	optional	string	Key regular expression
`exactMatch`	optional		Finds the exact match
`regexMatch`	optional		Finds the `regexMatch`
`dateFilterStart`	optional	string	The first value in the date filter
`dateFilterEnd`	optional	string	The last value in the date filter
`source`	optional	string	The data source. Default value is `"Direct API Upload"`.
`notifications`	optional	container	Contains the notification information. Includes the `method`, `state`, and `recipients` parameters.
`method`	optional	string	The method by which the notification is sent. This includes the enums `email` and `rabbit`.
`state`	optional	string	The state of the notification. Includes the following enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, and `completed`.
`recipients`	optional	string	The recipients of the notification

Response Parameters

The following table describes the POST export classification response parameters:

Name	Type	Description
`setName`	string	The name of the classification dataset
`jobId`	string	The ID of the job
`jobSize`	integer	The size of the job file
`jobOptions`	container	The export options of the job
`name`	string	The name of the job
`totalLines`	integer	The total lines of the file
`datasetId`	string	The classification dataset ID of the job
`noeffectLines`	integer	The no effect lines of export job
`history`	container	The history of the job. Contains the `timestamp`, `jobState`, and `message` parameters.
`timestamp`	string	The time when the job state changed
`jobState`	string	The state of the job. Includes the enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, `completed`.
`message`	string	The details of the job history
`state`	string	The state of the job
`type`	string	The type of the job
`imsOrgId`	string	The global company ID

GET export classification file

This endpoint is shown in the API reference as GET /job/export/file/{dataset_id}.

Use this endpoint to retrieve the contents of an export classification file. When using this endpoint, you must supply the export job ID returned with the POST export classification endpoint. For more information on classification data, see Classification data files.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/{JOB_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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 18:00:11  A:xxxxxx:xx
 
Key File Name   File Option Directory
KeyYYYY0522-1   File Name-1 Option-1    Directory-1
KeyYYYY0522-2   File Name-2 Option-2    Directory-2
KeyYYYY0522-3   File Name-3 Option-3    Directory-3
KeyYYYY0522-4   File Name-4 Option-4    Directory-4
KeyYYYY0522-5   File Name-5 Option-5    Directory-5
KeyYYYY0522-6   File Name-6 Option-6    Directory-6
KeyYYYY0522-7   File Name-7 Option-7    Directory-7
KeyYYYY0522-8   File Name-8 Option-8    Directory-8
KeyYYYY0522-9   File Name-9 Option-9    Directory-9
Copied to your clipboard
## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 18:00:11  A:xxxxxx:xx
 
Key File Name   File Option Directory
KeyYYYY0522-1   File Name-1 Option-1    Directory-1
KeyYYYY0522-2   File Name-2 Option-2    Directory-2
KeyYYYY0522-3   File Name-3 Option-3    Directory-3
KeyYYYY0522-4   File Name-4 Option-4    Directory-4
KeyYYYY0522-5   File Name-5 Option-5    Directory-5
KeyYYYY0522-6   File Name-6 Option-6    Directory-6
KeyYYYY0522-7   File Name-7 Option-7    Directory-7
KeyYYYY0522-8   File Name-8 Option-8    Directory-8
KeyYYYY0522-9   File Name-9 Option-9    Directory-9

Request example details

The example above shows a cURL request for the export file of the following job ID: 16e38fbc-fc82-4fdf-88de-ec33e63489d5.

Response example details

The example above returns a table containing the exported data.

Request Parameters

The following table describes the GET export classification file request parameters:

Name	Required	Type	Description
`job_id`	required	string	Export Job ID

Response Parameters

The response includes the classification data in the format specified with the export job request. No other response parameters are returned.

GET classification job file partition list

Use this endpoint to retrieve a list of file parts partitioned from a complete classification file belonging to an existing job. The individual file parts returned may be used in the GET classification export job file part endpoint to be exported. For more information on classification data, see Classification data files.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/{JOB_ID}/list

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.

Request Example

Response Example

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5/list" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5/list" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
    "count": 6,
    "files": [
        "part1.tsv",
        "part2.tsv",
        "part3.tsv",
        "part4.tsv",
        "part5.tsv",
        "part6.tsv"
    ]
}
Copied to your clipboard
{
    "count": 6,
    "files": [
        "part1.tsv",
        "part2.tsv",
        "part3.tsv",
        "part4.tsv",
        "part5.tsv",
        "part6.tsv"
    ]
}

Request example details

The example above requests the list of classification data file parts for the 16e38fbc-fc82-4fdf-88de-ec33e63489d5 job ID.

Response example details

The example above returns the count of total classification data file parts alongside the file name of each part.

Request Parameters

The following table describes the classification job file partition list request parameter:

Name	Required	Type	Description
`job_id`	required	string	The job ID for which the file parts will be returned

Response Parameters

The following table describes the classification job file partition list response parameters:

Name	Type	Description
`count`	integer	The number of files returned
`files`	container	An array containing the list of file part names

GET classification export job file part

Use this endpoint to retrieve a part of a complete classification data file. The GET classification job file partition list endpoint may be used to retrieve the file names required for this endpoint. For more information on classification data, see Classification data files.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/{JOB_ID}/{FILE_NAME}

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.

Request Example

Response Example

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5/part1.tsv" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/export/file/16e38fbc-fc82-4fdf-88de-ec33e63489d5/part1.tsv" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 18:00:11  A:xxxxxx:xx
 
Key    File Name   File Option    Directory
KeyYYYY0522-1     File Name-1    Option-1    Directory-1
KeyYYYY0522-2     File Name-2    Option-2    Directory-2
KeyYYYY0522-3     File Name-3    Option-3    Directory-3
Copied to your clipboard
## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 18:00:11  A:xxxxxx:xx
 
Key    File Name   File Option    Directory
KeyYYYY0522-1     File Name-1    Option-1    Directory-1
KeyYYYY0522-2     File Name-2    Option-2    Directory-2
KeyYYYY0522-3     File Name-3    Option-3    Directory-3

Request example details

The example above requests the classification data file part named part1.tsv belonging to the job 16e38fbc-fc82-4fdf-88de-ec33e63489d5.

Response example details

The example above responds with the data of the file part specified in the request.

Request Parameters

The following table describes the classification export job file part request parameters:

Name	Required	Type	Description
`job_id`	required	string	The job ID
`file_name`	required	string	The name of the file to be retrieved

Response Parameters

The response includes the classification data requested. No other response parameters are returned.

GET classification template

Use this endpoint to retrieve a template showing how to structure data. For more information on how to structure your classification files, see Classification data files and Classification template.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/template/{DATASET_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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/template/{DATASET_ID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/template/{DATASET_ID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 23:13:42  A:xxxxxx:xx
 
Key Column A    Column B    Column C    Column D
Copied to your clipboard
## SC   SiteCatalyst saint Import File  v:2.1
## SC   '## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.
## SC   D:YYYY-07-31 23:13:42  A:xxxxxx:xx
 
Key Column A    Column B    Column C    Column D

Request example details

The example above requests a template showing how to structure data.

Response example details

The example above returns a template showing how to structure data. For more information on how to structure your classification files, see Classification data files and Classification template.

Request Parameters

The following table describes the GET classification template file request parameters.

Name	Required	Type	Description
`dataset_id`	required	string	Classification dataset ID
`format`	optional	string	Template format. The default is `tsv`. Includes the `enum` options `tsv` or `csv`.

Response Parameters

The response includes a sample structure of how the data will be formatted while using the GET export classification file endpoint. No other response parameters are returned.

GET all classification datasets

Use this endpoint to retrieve all datasets for a specified report suite ID. For more information on classification sets, see Classification sets overview.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/compatibilityMetrics/{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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/compatibilityMetrics/{example_RSID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/compatibilityMetrics/{example_RSID}" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "report_suite_id": "example_RSID",
  "metrics": [
    {
      "id": [
        "evar5"
      ],
      "datasets": [
        "646e65bfc2d00205dbc5f034"
      ]
    },
    {
      "id": [
        "evar11"
      ],
      "datasets": [
        "64c437bc6f71754e2e56e019",
        "64c437886f71754e2e56e011",
        "64c437396f71754e2e56e005",
        "64c437616f71754e2e56e009"
      ]
    },
  ]
}
Copied to your clipboard
{
  "report_suite_id": "example_RSID",
  "metrics": [
    {
      "id": [
        "evar5"
      ],
      "datasets": [
        "646e65bfc2d00205dbc5f034"
      ]
    },
    {
      "id": [
        "evar11"
      ],
      "datasets": [
        "64c437bc6f71754e2e56e019",
        "64c437886f71754e2e56e011",
        "64c437396f71754e2e56e005",
        "64c437616f71754e2e56e009"
      ]
    },
  ]
}

Request example details

The example above shows a cURL request for the classification datasets associated with {example_RSID}.

Response example details

The example above returns the following classification datasets:

The dataset associated with evar5: 646e65bfc2d00205dbc5f034.
The datasets associated with evar11, including 64c437bc6f71754e2e56e019, 64c437886f71754e2e56e011, 64c437396f71754e2e56e005, and 64c437616f71754e2e56e009.

Request Parameters

The following table describes the GET all classification datasets request parameters.

Name	Required	Type	Description
`rsid`	required	string	Adobe Analytics report suite ID

Response Parameters

The following table describes the GET all classification datasets response parameters.

Name	Type	Description
`metrics`	container	Contains the `id`, and `datasets` parameters
`id`	string	ID
`datasets`	string	Datasets
`report_suite_id`	string	The report suite ID

GET a single classification

Use this endpoint to retrieve information for a specified dataset. For more information on classification sets, see Classification sets overview.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{DATASET_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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{64b1d77b235090539e282308}"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{64b1d77b235090539e282308}"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "name": "testsuite evar7 classifications",
  "description": "testsuite evar7 classifications",
  "default_list_delimiter": ",",
  "default_encoding": "UTF8",
  "columns": [
    {
      "column_id": "5849115441721086447",
      "name": "Column A",
      "display_name": "Column A",
      "type": "text",
    },
    {
      "column_id": "495411758226162142",
      "name": "Column B",
      "display_name": "Column B",
      "type": "text",
    },
  ],
  "subscriptions": [
    {
      "rsid": "testsuite",
      "dimension": "variables/evar7",
      "unique": true,
      "editable": true
    }
  ],
  "notifications": [],
  "dataset_id": "64b1d77b235090539e282308",
  "ims_org_id": "0DFE76D95967D5B50A494010@AdobeOrg",
  "owner": {
    "name": "example_name",
    "email": "example_namey@example.com"
  },
  "last_modified_date": "YYYY-07-14T23:35:10Z"
}
Copied to your clipboard
{
  "name": "testsuite evar7 classifications",
  "description": "testsuite evar7 classifications",
  "default_list_delimiter": ",",
  "default_encoding": "UTF8",
  "columns": [
    {
      "column_id": "5849115441721086447",
      "name": "Column A",
      "display_name": "Column A",
      "type": "text",
    },
    {
      "column_id": "495411758226162142",
      "name": "Column B",
      "display_name": "Column B",
      "type": "text",
    },
  ],
  "subscriptions": [
    {
      "rsid": "testsuite",
      "dimension": "variables/evar7",
      "unique": true,
      "editable": true
    }
  ],
  "notifications": [],
  "dataset_id": "64b1d77b235090539e282308",
  "ims_org_id": "0DFE76D95967D5B50A494010@AdobeOrg",
  "owner": {
    "name": "example_name",
    "email": "example_namey@example.com"
  },
  "last_modified_date": "YYYY-07-14T23:35:10Z"
}

Request example details

The example above shows a cURL request of the data associated with the dataset {64b1d77b235090539e282308}.

Response example details

The example above returns the following information for the dataset named: testsuite evar7 classifications:

The name of the two columns are "Column A" and "Column B".
The column_id for the two columns are 5849115441721086447 and 495411758226162142.
The name of the dataset is testsuite evar7 classifications.
The subscription is associated with the testsuite report suite ID.

Request Parameters

The following table describes the request parameters for this endpoint:

Name	Required	Type	Description
`dataset_id`	required	string	Classification Dataset ID

Response Parameters

The following table describes the response parameters for this endpoint:

Parameter	Type	Description
`owner`	container	Contact information that contains the `name` and `email` parameters
`name`	string	Name of person responsible for the classification definition and/or data
`email`	string	Email address for person responsible for the classification definition and/or data
`subscriptions`	container	A list of classification subscriptions. Subscriptions are not required at the time of creation but no data will be classified until at least one subscription exists. Contains the `rsid`, `dimension`, `unique`, and `editable` parameters. For more information, see Classification settings.
`rsid`	string	The report suite ID
`dimension`	string	The dimension you would like to be classified. Should be prefixed with `variables/`, e.g., `variables/page`.
`unique`	boolean	Whether a forced update of unique_hash is used to avoid duplicate subscriptions
`editable`	boolean	Whether the subscription is editable by the current user based on report suite permissions
`default_encoding`	string	Default encoding for jobs. Defaults to `utf8`. Includes the enums `utf8` and `latin1`.
`columns`	container	A list of classification column definitions. Column definitions are not required at the time of creation but no data will be classified until at least one column definition exists. Contains the `column_id`, `name`, `display_name`, `type`, and `classified_by`.
`column_id`	string	A UUID that is generated when a column is created
`name`	string	The name for this given data column. It cannot be changed after column creation. It also can be any valid UTF-8 string.
`display_name`	string	The display name for the given data column. The value can be changed. It can be any valid UTF-8 string.
`type`	string	Defaults to `text`. This cannot be changed after column creation. Includes the following enums: `text`, `integer`, `float`, and `list`.
`classified_by`	string	An optional classification dataset ID that classifies this column's data
`dataset_id`	string	An auto-generated ID value created by the system on creation of the dataset, in the form of an ObjectId
`name`	string	A friendly display name for users to easily identify the classification definition
`description`	string	A long description for the purpose of this classification set
`last_modified_date`	string	The last modified date/time of the classification set
`last_modified_by`	string	The email address of the last person that modified the classification set
`ims_org_id`	string	The ID associated with the analytics company of the user
`default_list_delimiter`	string	The default delimiter for list column types. Defaults to `,` (comma). If you have no list columns, this field does not apply.
`notifications`	container	Contains the notification information. Includes the `method`, `state`, and `recipients` parameters.
`method`	string	The method by which the notification is sent. This includes the enums `email` and `rabbit`.
`state`	string	The state of the notification. Includes the following enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, and `completed`.
`recipients`	string	The recipients of the notification

GET classification job information

Use this endpoint to retrieve job information for a specified job ID. For more information about classification jobs, see Classification set jobs manager.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/{JOB_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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/7dafc070-afec-4a8d-8187-24f572f7d0f8"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/7dafc070-afec-4a8d-8187-24f572f7d0f8"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "datasetId": "6449b63563c1e069c6159415",
  "history": [
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "created",
      "message": "Created export job via API"
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "queued",
      "message": "Job queued and ready for processing."
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "processing",
      "message": "Started processing"
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:58",
      "jobState": "completed",
      "message": "Successfully exported 50000/50000 records."
    }
  ],
  "imsOrgId": "0DFE76D95967D5B50A494010@AdobeOrg",
  "jobOptions": {
    "dataFormat": "tsv",
    "encoding": "utf8",
    "listDelimiter": ",",
    "rowLimit": 50000,
    "offset": 0,
    "dateFilterStart": "YYYY-MM-DDT22:29:07Z",
    "dateFilterEnd": "YYYY-MM-DDT16:06:55Z",
    "notifications": [
      {
        "method": "email",
        "state": "failed_validation",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "failed_processing",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "completed",
        "recipients": [
          "john@example.com"
        ]
      }
    ]
  },
  "jobId": "7dafc070-afec-4a8d-8187-24f572f7d0f8",
  "jobSize": 26410225,
  "name": "example_dataset_name-example-dataset_id at example_time",
  "setName": "taxoappsrvtest evar1 classifications",
  "state": "completed",
  "totalLines": 50000,
  "noeffectLines": null,
  "type": "export"
}
Copied to your clipboard
{
  "datasetId": "6449b63563c1e069c6159415",
  "history": [
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "created",
      "message": "Created export job via API"
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "queued",
      "message": "Job queued and ready for processing."
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:56",
      "jobState": "processing",
      "message": "Started processing"
    },
    {
      "timestamp": "YYYY-MM-DD 22:06:58",
      "jobState": "completed",
      "message": "Successfully exported 50000/50000 records."
    }
  ],
  "imsOrgId": "0DFE76D95967D5B50A494010@AdobeOrg",
  "jobOptions": {
    "dataFormat": "tsv",
    "encoding": "utf8",
    "listDelimiter": ",",
    "rowLimit": 50000,
    "offset": 0,
    "dateFilterStart": "YYYY-MM-DDT22:29:07Z",
    "dateFilterEnd": "YYYY-MM-DDT16:06:55Z",
    "notifications": [
      {
        "method": "email",
        "state": "failed_validation",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "failed_processing",
        "recipients": [
          "john@example.com"
        ]
      },
      {
        "method": "email",
        "state": "completed",
        "recipients": [
          "john@example.com"
        ]
      }
    ]
  },
  "jobId": "7dafc070-afec-4a8d-8187-24f572f7d0f8",
  "jobSize": 26410225,
  "name": "example_dataset_name-example-dataset_id at example_time",
  "setName": "taxoappsrvtest evar1 classifications",
  "state": "completed",
  "totalLines": 50000,
  "noeffectLines": null,
  "type": "export"
}

Request example details

The example above shows a cURL request for the job information associated with the 7dafc070-afec-4a8d-8187-24f572f7d0f8 job ID.

Response example details

The example above returns the following classification job information:

The history of the job, including the details associated with its various states. This includes the created, queued, processing, and completed states.
The recipient for the state notifications: john@example.com.
The name of the job is example_dataset_name-example-dataset_id at example_time.
The final state of the job is completed.

Request Parameters

The following table describes the GET classification job information request parameters:

Name	Required	Type	Description
`job_id`	required	string	Classification Job ID

Response Parameters

The following table describes the GET classification job information response parameters:

Name	Type	Description
`setName`	string	The name of the classification dataset
`jobId`	string	The ID of the job
`jobSize`	integer	The size of the job file
`jobOptions`	container	The import or export options of the job
`name`	string	The name of the job
`totalLines`	integer	The total lines of the file
`datasetId`	string	The classification dataset ID of the job
`noeffectLines`	integer	The no effect lines of import job
`history`	container	The history of the job. Contains the `timestamp`, `jobState`, and `message` parameters.
`timestamp`	string	The time when the job state changed
`jobState`	string	The state of the job. Includes the enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, `completed`.
`message`	string	The details of the job history
`state`	string	The state of the job
`type`	string	The type of the job
`imsOrgId`	string	The global company ID

GET classification jobs by dataset

Use this endpoint to retrieve job information for a specified dataset ID. For more information about classification jobs, see Classification set jobs manager.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/byDataset/{DATASET_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.

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/byDataset/{DATASET_ID}?page=0&size=10" \
     -H "Accept: */*" \
     -H "User-Agent: Example Client (https://www.exampleclient.com)" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/job/byDataset/{DATASET_ID}?page=0&size=10" \
     -H "Accept: */*" \
     -H "User-Agent: Example Client (https://www.exampleclient.com)" \
     -H "x-api-key: {CLIENT_ID}" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "content": [
    {
      "datasetId": "exampledatasetxxd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "created",
          "message": "Created import job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:15",
          "jobState": "completed",
          "message": "Successfully imported 5/5 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "keyOptions": {
          "byte_length": 255,
          "type": "string",
          "overwrite": true
        }
      },
      "jobId": "5cd1e9c9-de84-4cf4-8e67-6f5a6d2ec186",
      "jobSize": 384,
      "name": "Example Import for phpVUNxEV",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 5,
      "noeffectLines": 0,
      "type": "import"
    },
    {
      "datasetId": "exampledatasetd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:14:56",
          "jobState": "created",
          "message": "Created import job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:56",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:57",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:58",
          "jobState": "completed",
          "message": "Successfully imported 5/5 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "keyOptions": {
          "byte_length": 255,
          "type": "string",
          "overwrite": true
        }
      },
      "jobId": "0f37093f-d2a0-46b6-b2b6-e58316970808",
      "jobSize": 383,
      "name": "Example Import for phpaahhNJ",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 5,
      "noeffectLines": 0,
      "type": "import"
    },
    {
      "datasetId": "exampledatasetd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "created",
          "message": "Created export job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "completed",
          "message": "Successfully exported 0/0 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "rowLimit": 0,
        "offset": 0,
        "dateFilterStart": "YYYY-MM-01T00:00:00Z",
        "dateFilterEnd": "YYYY-MM-31T23:59:59Z"
      },
      "jobId": "0ede459b-9e30-4ccb-801a-57f47fa6fe6e",
      "jobSize": 231,
      "name": "Example Export",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 0,
      "noeffectLines": null,
      "type": "export"
    }
  ],
  "page": 0,
  "size": 10,
  "totalPages": 1,
  "totalElements": 3,
  "numberOfElements": 3,
  "first": true,
  "last": true
}
Copied to your clipboard
{
  "content": [
    {
      "datasetId": "exampledatasetxxd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "created",
          "message": "Created import job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:14",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:15:15",
          "jobState": "completed",
          "message": "Successfully imported 5/5 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "keyOptions": {
          "byte_length": 255,
          "type": "string",
          "overwrite": true
        }
      },
      "jobId": "5cd1e9c9-de84-4cf4-8e67-6f5a6d2ec186",
      "jobSize": 384,
      "name": "Example Import for phpVUNxEV",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 5,
      "noeffectLines": 0,
      "type": "import"
    },
    {
      "datasetId": "exampledatasetd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:14:56",
          "jobState": "created",
          "message": "Created import job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:56",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:57",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:14:58",
          "jobState": "completed",
          "message": "Successfully imported 5/5 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "keyOptions": {
          "byte_length": 255,
          "type": "string",
          "overwrite": true
        }
      },
      "jobId": "0f37093f-d2a0-46b6-b2b6-e58316970808",
      "jobSize": 383,
      "name": "Example Import for phpaahhNJ",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 5,
      "noeffectLines": 0,
      "type": "import"
    },
    {
      "datasetId": "exampledatasetd9",
      "history": [
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "created",
          "message": "Created export job via API"
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "queued",
          "message": "Job queued and ready for processing."
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "processing",
          "message": "Started processing"
        },
        {
          "timestamp": "YYYY-MM-DD 21:13:41",
          "jobState": "completed",
          "message": "Successfully exported 0/0 records."
        }
      ],
      "imsOrgId": "exampleorg@AdobeOrg",
      "jobOptions": {
        "dataFormat": "tsv",
        "encoding": "utf8",
        "listDelimiter": ",",
        "rowLimit": 0,
        "offset": 0,
        "dateFilterStart": "YYYY-MM-01T00:00:00Z",
        "dateFilterEnd": "YYYY-MM-31T23:59:59Z"
      },
      "jobId": "0ede459b-9e30-4ccb-801a-57f47fa6fe6e",
      "jobSize": 231,
      "name": "Example Export",
      "setName": "exampleset evar11 classifications",
      "state": "completed",
      "totalLines": 0,
      "noeffectLines": null,
      "type": "export"
    }
  ],
  "page": 0,
  "size": 10,
  "totalPages": 1,
  "totalElements": 3,
  "numberOfElements": 3,
  "first": true,
  "last": true
}

Request example details

The example above requests the following classification job information:

The job information associated with the dataset ID exampledatasetxxd9.
The page to be returned is 0, or the first page.
The size of each page should be limited to 10 jobs.

Response example details

The example above returns the following classification job information for the provided dataset ID:

The history of each of the jobs, including the details associated with its various states. This includes the created, queued, processing, and completed states.
The jobOptions of each of the jobs, including the dataFormat, encoding, and listDelimiter parameters.
The jobId of each of the jobs.
The totalElements of the specified dataset are 3.

Request Parameters

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

Response Parameters

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

PUT classification dataset update

Use this endpoint to update a classification dataset.

PUT https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{DATASET_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.

Request

Response

curl -X PUT "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{DATASET_ID}"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X PUT "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{DATASET_ID}"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "name": "taxoappsrvtest evar7 classifications",
  "description": "taxoappsrvtest evar7 classifications",
  "default_list_delimiter": ",",
  "default_encoding": "UTF8",
  "columns": [
    {
      "column_id": "5849115441721086447",
      "name": "Column A",
      "display_name": "Column A",
      "type": "text",
      ]
    },
    {
      "column_id": "495411758226162142",
      "name": "Column B",
      "display_name": "Column B",
      "type": "text",
      ]
    },
    {
      "column_id": "399739691265197434",
      "name": "Column C",
      "display_name": "Column C",
      "type": "text",
      ]
    },
    {
      "column_id": "1759968069842527446",
      "name": "Column D",
      "display_name": "Column D",
      "type": "text",
    }
  ],
  "subscriptions": [
    {
      "rsid": "taxoappsrvtest",
      "dimension": "variables/evar7",
      "unique": true,
      "editable": true
    },
    {
      "rsid": "taxoappsrvtest",
      "dimension": "taxoappsrvdataingesttest0/evar75",
      "unique": true,
      "editable": true
    }
  ],
  "notifications": [],
  "dataset_id": "64b1d77b235090539e282308",
  "ims_org_id": "0DFE76D95967D5B50A494010@AdobeOrg",
  "owner": {
    "name": "Unknown User",
    "email": "no-reply@adobe.com"
  },
  "last_modified_date": "YYYY-07-14T23:35:10Z"
}
Copied to your clipboard
{
  "name": "taxoappsrvtest evar7 classifications",
  "description": "taxoappsrvtest evar7 classifications",
  "default_list_delimiter": ",",
  "default_encoding": "UTF8",
  "columns": [
    {
      "column_id": "5849115441721086447",
      "name": "Column A",
      "display_name": "Column A",
      "type": "text",
      ]
    },
    {
      "column_id": "495411758226162142",
      "name": "Column B",
      "display_name": "Column B",
      "type": "text",
      ]
    },
    {
      "column_id": "399739691265197434",
      "name": "Column C",
      "display_name": "Column C",
      "type": "text",
      ]
    },
    {
      "column_id": "1759968069842527446",
      "name": "Column D",
      "display_name": "Column D",
      "type": "text",
    }
  ],
  "subscriptions": [
    {
      "rsid": "taxoappsrvtest",
      "dimension": "variables/evar7",
      "unique": true,
      "editable": true
    },
    {
      "rsid": "taxoappsrvtest",
      "dimension": "taxoappsrvdataingesttest0/evar75",
      "unique": true,
      "editable": true
    }
  ],
  "notifications": [],
  "dataset_id": "64b1d77b235090539e282308",
  "ims_org_id": "0DFE76D95967D5B50A494010@AdobeOrg",
  "owner": {
    "name": "Unknown User",
    "email": "no-reply@adobe.com"
  },
  "last_modified_date": "YYYY-07-14T23:35:10Z"
}

Request example details

The example above shows a cURL request to update the dataset ID 7dafc070-afec-4a8d-8187-24f572f7d0f8.

Request Parameters

The following table describes the request parameters for this endpoint:

Name	Required	Type	Description
`dataset_id`	required	string	Classification Dataset ID
`owner`	optional	container	Contact information that contains the `name` and `email` parameters
`name`	optional	string	Name of person responsible for the classification definition and/or data
`email`	optional	string	Email address for person responsible for the classification definition and/or data
`subscriptions`	required	container	A list of classification subscriptions. Subscriptions are not required at the time of creation but no data will be classified until at least one subscription exists. Contains the `rsid`, `dimension`, and `unique` parameters.
`rsid`	required	string	The report suite ID
`dimension`	required	string	The dimension you would like to be classified. Should be prefixed with `variables/`, e.g., `variables/page`.
`unique`	required	boolean	Whether a forced update of unique_hash is used to avoid duplicate subscriptions
`default encoding`	optional	string	Default encoding for jobs. Defaults to `utf8`. Includes the enums: `utf8` and `latin1`.
`columns`	required	container	A list of classification column definitions. Column definitions are not required at the time of creation but no data will be classified until at least one column definition exists. Contains the `name`, `display_name`, `type`, and `classified_by`.
`name`	required	string	The name for this given data column. It cannot be changed after column creation. It also can be any valid UTF-8 string.
`display_name`	required	string	The display name for the given data column. The value can be changed. It can be any valid UTF-8 string.
`type`	optional	string	Defaults to `text`. This cannot be changed after column creation. Includes the following enums: `text`, `integer`, `float`, and `list`.
`classified_by`	optional	string	An optional classification dataset ID that classifies this column's data
`name`	optional	string	A friendly display name for users to easily identify the classification definition
`description`	optional	string	A long description for the purpose of this classification set
`default_list_delimiter`	optional	string	The default delimiter for list column types. Defaults to `,` (comma). If you have no list columns, this field does not apply.
`notifications`	optional	container	Contains the notification information. Includes the `method`, `state`, and `recipients` parameters.
`method`	optional	string	The method by which the notification is sent. This includes the enums `email` and `rabbit`.
`state`	optional	string	The state of the notification. Includes the following enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, and `completed`.
`recipients`	optional	string	The recipients of the notification

Response Parameters

The following table describes the response parameters for this endpoint:

Name	Type	Description
`owner`	container	Contact information that contains the `name` and `email` parameters
`name`	string	Name of person responsible for the classification definition and/or data
`email`	string	Email address for person responsible for the classification definition and/or data
`subscriptions`	container	A list of classification subscriptions. Subscriptions are not required at the time of creation but no data will be classified until at least one subscription exists. Contains the `rsid`, `dimension`, `unique`, and `editable` parameters.
`rsid`	string	The report suite ID
`dimension`	string	The dimension you would like to be classified. Should be prefixed with `variables/`, e.g., `variables/page`.
`unique`	boolean	Whether a forced update of unique_hash is used to avoid duplicate subscriptions
`editable`	boolean	Whether the subscription is editable by the current user based on report suite permissions
`default encoding`	string	Default encoding for jobs. Defaults to `utf8`. Includes the enums: `utf8` and `latin1`.
`columns`	container	A list of classification column definitions. Column definitions are not required at the time of creation but no data will be classified until at least one column definition exists. Contains the `column_id`, `name`, `display_name`, `type`, and `classified_by` parameters.
`column_id`	string	A UUID that will be generated when a column is created
`name`	string	The name for this given data column. It cannot be changed after column creation. It also can be any valid UTF-8 string.
`display_name`	string	The display name for the given data column. The value can be changed. It can be any valid UTF-8 string.
`type`	string	Defaults to `text`. This cannot be changed after column creation. Includes the following enums: `text`, `integer`, `float`, and `list`.
`classified_by`	string	An optional classification dataset ID that classifies this column's data
`dataset_id`	string	An auto-generated ID value created by the system on creation of the dataset, in the form of an ObjectId
`name`	string	A friendly display name for users to easily identify the classification definition
`description`	string	A long description for the purpose of this classification set
`last_modified_date`	string	Last modified date/time of the classification set
`last_modified_by`	string	Email address of the last person that modified the classification set
`ims_org_id`	string	The ID associated with the analytics company of the user
`default_list_delimiter`	string	The default delimiter for list column types. Defaults to `,` (comma). If you have no list columns, this field does not apply.
`notifications`	container	Contains the notification information. Includes the `method`, `state`, and `recipients` parameters.
`method`	string	The method by which the notification is sent. This includes the enums `email` and `rabbit`.
`state`	string	The state of the notification. Includes the following enums: `created`, `queued`, `validated`, `failed_validation`, `processing`, `done_processing`, `failed_processing`, and `completed`.
`recipients`	string	The recipients of the notification

DELETE classification

Use this endpoint to delete a specified classification. For more information, see Delete classification data.

DELETE https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/{DATASET_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.

Request

Response

curl -X PUT "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/6449b63563c1e069c6159415"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X PUT "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/classifications/datasets/6449b63563c1e069c6159415"
     -H "x-api-key: {CLIENT_ID}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "success": true,
  "message": "The dataset 6449b63563c1e069c6159415 has been deleted"
}
Copied to your clipboard
{
  "success": true,
  "message": "The dataset 6449b63563c1e069c6159415 has been deleted"
}

Request example details

The example above shows a cURL request to delete the 6449b63563c1e069c6159415 dataset ID.

Response example details

The example above returns the following:

The job is successful.
The message provides additional conformation of the DELETE job.

Request Parameters

This request contains only one parameter, as described below:

Name	Required	Type	Description
`dataset_id`	required	string	Classification Dataset ID

Response Parameters

The following table describes the DELETE classification response parameters:

Name	Type	Description
`success`	boolean	Whether the DELETE request succeded
`message`	string	Additional information

FAQ

Import classificatons by uploading files

Last updated 8/6/2024

Was this helpful?

Yes

Analytics Classifications API

Classification Jobs.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Importing classification datasets

POST import JSON classification

Request and Response Examples.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Request example details

Response example details

Request parameters

Response Parameters

POST export classification

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET export classification file

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET classification job file partition list

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET classification export job file part

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET classification template

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET all classification datasets

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET a single classification

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET classification job information

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

GET classification jobs by dataset

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

PUT classification dataset update

Request and Response Examples

Request example details

Request Parameters

Response Parameters

DELETE classification

Request and Response Examples

Request example details

Response example details

Request Parameters

Response Parameters

Classification Jobs

Request and Response Examples