1.4 Classifications API

Analytics classifications lets you bulk-import additional data attributes, or dimensions, to Adobe Analytics. By augmenting the data elements collected by Analytics with these attributes, users can create deeper and more complex reports.

CommitImport

Submits a classifications import file for processing.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.CommitImport

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CommitImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"job_id": 436653464}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CommitImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"job_id": 436653464}'

true
Copied to your clipboard
true

Parameter	Type	Description
`job_id`	`int`	The job ID to commit for processing.

Returns true if the job processes successfully.

CreateExport

Creates a classifications export job.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateExport

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateExport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": "trackingcode",
    "email_address": "jdoe@gmail.com",
    "date_filter_start_date": "2020-01-01",
    "date_filter_end_date": "2022-12-31"
}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateExport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": "trackingcode",
    "email_address": "jdoe@gmail.com",
    "date_filter_start_date": "2020-01-01",
    "date_filter_end_date": "2022-12-31"
}'

{
    "job_id": 436650540
}
Copied to your clipboard
{
    "job_id": 436650540
}

This file represents classifications for a given relation. Before calling this API, use Classifications.GetFilters to obtain valid column numbers, names, and filter dates.

After creating an export job, use Classifications.GetStatus to determine when the export data is ready for download. When ready, use Classifications.GetExport to retrieve the data.

Parameter	Type	Description
`campaign_filter_start_date`	`string`	The campaign start date. Accepts any date string parseable by `php:date()`. Accepts the keywords `::all::` and `::active::` to filter by all campaigns, or by only active ones. This filter is off by default.
`campaign_filter_end_date`	`string`	The campaign end date. Accepts any date string parseable by `php:date()`.
`date_filter_start_date`	`string`	Accepts any date string parseable by `php:date()`.
`date_filter_end_date`	`string`	Accepts any date string parseable by `php:date()`.
`email_address`	`string`	The email address to receive job notifications.
`encoding`	`string`	The language encoding to use with the export file. For example, UTF-8.
`element`	`string`	You get this ID as a return value from `Classifications.GetCompatibilityElements`.
`rsid_list`	`string[]`	(Optional) The list of report suites on which classifications exports data.
`row_filter_column_name`	`string`	This field accepts the column name except when the `row_filter_column_value` is set to `::none::`.
`row_filter_column_value`	`string`	This field is always required if `row_filter_column_name` is included.
`row_filter_empty_column`	`string`	Can be set to: `::all::` - Returns rows that have all columns empty. `::any::` - Returns rows that have 1 or more empty column. Any column name - Returns rows where the given column is empty.
`all_rows`	`string`	Set to `true` to have all matching rows returned.
`row_count`	`int`	(Optional) Limits the number of data rows in the export file to the specified value. The default is 1000.
`quote_output`	`boolean`	Whether to quote the output. In some cases, turning this on helps with duplicate keys containing whitespace.

Returns the int Job ID associated with your export request.

CreateFTP

Creates a classifications Import FTP account.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateFTP

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateFTP' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": 1,
    "description": "Sample FTP import account",
    "email_address": "rmaur@adobe.com",
    "overwrite": false,
    "export": true
}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateFTP' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": 1,
    "description": "Sample FTP import account",
    "email_address": "rmaur@adobe.com",
    "overwrite": false,
    "export": true
}'

{
    "host": "ftp.omniture.com",
    "username": "examplersid_3904666",
    "password": "password"
}
Copied to your clipboard
{
    "host": "ftp.omniture.com",
    "username": "examplersid_3904666",
    "password": "password"
}

Parameter	Type	Description
`element`	`int`	`relation_id` that you want to import or export (e.g. 101=evar1, 51=product, etc)
`rsid_list`	`string[]`	report suites to which data is imported.
`description`	`string`	a textual description for the FTP account.
`email_address`	`string`	the email account to notify when imports are finished.
`overwrite`	`boolean`	if `true`, keys that already exist will always be overwritten by new keys. NOTE: This option is not available for report suites enabled for the new classification architecture.
`export`	`boolean`	if `true`, the import will be automatically exported after import. NOTE: This option is not available for report suites enabled for the new classification architecture.

Returns classifications_ftp_info, which contains connection details for the created FTP account.

CreateImport

Creates a classifications import job.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateImport

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": "trackingcode",
    "check_divisions": 0,
    "description": "Sample import job",
    "email_address": "jdoe@gmail.com",
    "export_results": 0,
    "header": [
        "Key",
        "Program Name",
        "Activity Name",
        "Tag ID",
        "Tag Name"
    ],
    "overwrite_conflicts": 0
}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.CreateImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "rsid_list": [
        "examplersid"
    ],
    "element": "trackingcode",
    "check_divisions": 0,
    "description": "Sample import job",
    "email_address": "jdoe@gmail.com",
    "export_results": 0,
    "header": [
        "Key",
        "Program Name",
        "Activity Name",
        "Tag ID",
        "Tag Name"
    ],
    "overwrite_conflicts": 0
}'

{
    "job_id": 436653464
}
Copied to your clipboard
{
    "job_id": 436653464
}

To successfully submit a classifications Import, call Classifications.CreateImport to specify the parameters for the Import job and the header columns to be classified.

After submitting the job, you can iteratively populate row data by calling Classifications.PopulateImport.

After sending all data, call Classifications.CommitImport to finalize the Import job and submit it to the processing queue.

Parameter	Type	Description
`rsid_list`	`string[]`	The list of report suites to receive the import job.
`element`	`string`	The report for which you want to perform a classifications import.
`check_divisions`	`int`	Specifies whether to check report suites for compatible divisions. Supported values include: `0`: Do not check report suite compatibility. `1`: (Default) Check report suite compatibility.
`description`	`string`	A description of the import job.
`email_address`	`string`	The email address to receive job notifications.
`export_results`	`int`	Specifies whether to automatically perform an export when the import job finishes processing. Supported values include: `0`: (Default) Do not export. `1`: Export when the job completes. NOTE: This option is not available for report suites enabled for the new classification architecture.
`header`	`string[]`	An array of column values for classification. First column is required to be the `key`.
`overwrite_conflicts`	`int`	Specifies whether to overwrite data when conflicts occur. Supported values include: `0`: (Default) Do not overwrite data on a conflict. `1`: Overwrite data on a conflict. NOTE: This option is not available for report suites enabled for the new classification architecture.

Returns classifications_create_job_response, a unique int job ID that identifies this classifications import job. If the job import is unsuccessful, an error code is returned instead of a job ID.

GetCompatibilityElements

Returns the available elements for a given report suite, and compatibility across report suites.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetCompatibilityElements

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetCompatibilityElements' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"]}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetCompatibilityElements' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"]}'

[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "compatibility_elements": [
            {
                "id": "tntbase",
                "name": "Adobe Target"
            },
            {
                "id": "trackingcode",
                "name": "Campaigns"
            },
            {
                "id": "evar12",
                "name": "User Authentication System (v12)"
            },
            {
                "id": "firsttouchchannel",
                "name": "First Touch Channel"
            },
            {
                "id": "lasttouchchannel",
                "name": "Last Touch Channel"
            },
            {
                "id": "page",
                "name": "Pages"
            },
            {
                "id": "listvar1",
                "name": "Survey Responses"
            },
            {
                "id": "evar2",
                "name": "Solution (v2)"
            },
            {
                "id": "evar8",
                "name": "User Account Type (v8)"
            },
            {
                "id": "evar28",
                "name": "Page URL Clean (v28)"
            },
            {
                "id": "evar116",
                "name": "Named Role List (v116)"
            },
            {
                "id": 1342,
                "name": "Forum Screen Name"
            }
        ]
    }
]
Copied to your clipboard
[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "compatibility_elements": [
            {
                "id": "tntbase",
                "name": "Adobe Target"
            },
            {
                "id": "trackingcode",
                "name": "Campaigns"
            },
            {
                "id": "evar12",
                "name": "User Authentication System (v12)"
            },
            {
                "id": "firsttouchchannel",
                "name": "First Touch Channel"
            },
            {
                "id": "lasttouchchannel",
                "name": "Last Touch Channel"
            },
            {
                "id": "page",
                "name": "Pages"
            },
            {
                "id": "listvar1",
                "name": "Survey Responses"
            },
            {
                "id": "evar2",
                "name": "Solution (v2)"
            },
            {
                "id": "evar8",
                "name": "User Account Type (v8)"
            },
            {
                "id": "evar28",
                "name": "Page URL Clean (v28)"
            },
            {
                "id": "evar116",
                "name": "Named Role List (v116)"
            },
            {
                "id": 1342,
                "name": "Forum Screen Name"
            }
        ]
    }
]

Parameter	Type	Description
`rsid_list`	`string[]`	A list of report suites where you want to get valid element values.

Returns classifications_report_suite_compatibility_elements[], a list of compatible elements.

GetExport

Retrieves a page of data, known as a file segment, from a completed classifications job.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetExport

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetExport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"file_id": 429589830, "page": 1}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetExport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"file_id": 429589830, "page": 1}'

[
    {
        "warnings": null,
        "header": [
            "Key",
            "Program Name",
            "Activity Name",
            "Tag ID",
            "Tag Name"
        ],
        "data": [
            {
                "row": [
                    "NC5SAQRLXC",
                    "Retention Resources",
                    "Retention Docs Links",
                    "NC5FRLXC301",
                    "Retention Docs Tag"
                ]
            },
            {
                "row": [
                    "M7K4VSQR2T",
                    "NA_FY20_CM_Analytics New User",
                    "Start First Project",
                    "M7K4SR2T888",
                    "Start First Project video"
                ]
            }
        ]
    }
]
Copied to your clipboard
[
    {
        "warnings": null,
        "header": [
            "Key",
            "Program Name",
            "Activity Name",
            "Tag ID",
            "Tag Name"
        ],
        "data": [
            {
                "row": [
                    "NC5SAQRLXC",
                    "Retention Resources",
                    "Retention Docs Links",
                    "NC5FRLXC301",
                    "Retention Docs Tag"
                ]
            },
            {
                "row": [
                    "M7K4VSQR2T",
                    "NA_FY20_CM_Analytics New User",
                    "Start First Project",
                    "M7K4SR2T888",
                    "Start First Project video"
                ]
            }
        ]
    }
]

Parameter	Type	Description
`file_id`	`int`	The ID of the export file you want to view. You can get this value from `Classifications.GetStatus`.
`page`	`int`	The number of the data page you want to view from the export job. Default is 1. The `viewable_pages` value in `Classifications.GetStatus` indicates the number of data pages in the job. Valid values for `page` are between 1 and the value of `viewable_pages`.

Returns pagedetails, information and data for the specified data segment.

GetFilters

Gets classification export filters.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFilters

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFilters' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"], "element": 1}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFilters' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"], "element": 1}'

{
    "columns": [
        "Site Section"
    ],
    "filter_dates": [
        "Oct 2023",
        "Sep 2023",
        "Aug 2023",
        "...",
        "Pre"
    ]
}
Copied to your clipboard
{
    "columns": [
        "Site Section"
    ],
    "filter_dates": [
        "Oct 2023",
        "Sep 2023",
        "Aug 2023",
        "...",
        "Pre"
    ]
}

The returned data consists of values that can be passed in as parameters of Classifications.CreateExport, including column numbers and names, and valid dates for filtering data rows in a classifications export.

Parameter	Type	Description
`rsid_list`	`string[]`	A list of report suites that contains the specified data source.
`element`	`string`	The element for which you want to get file information.

Returns classifications_filters, information about valid filters for the specified data segment.

GetFTP

Returns a list of the classifications FTP accounts that are configured for a company. Does not require a JSON request body.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFTP

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFTP' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"]}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetFTP' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"]}'

[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "ftp": [
            {
                "description": "Sample FTP import account",
                "overwrite": false,
                "export": true,
                "email_address": "jdoe@gmail.com",
                "host": "ftp.omniture.com",
                "username": "examplersid_3904666",
                "element": "page"
            }
        ]
    }
]
Copied to your clipboard
[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "ftp": [
            {
                "description": "Sample FTP import account",
                "overwrite": false,
                "export": true,
                "email_address": "jdoe@gmail.com",
                "host": "ftp.omniture.com",
                "username": "examplersid_3904666",
                "element": "page"
            }
        ]
    }
]

Parameter	Type	Description
rsid_list	`string[]`	report suites for which you want to retrieve FTP information.

Returns classifications_report_suite_ftp[], struct containing details with the FTP accounts for a report suite.

GetStatus

Returns the status of the specified classification request.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetStatus

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetStatus' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"job_id": 436650540}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetStatus' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"job_id": 436650540}'

[
    {
        "id": 436651124,
        "type": "job_id",
        "viewable_pages": 0,
        "status": "Completed"
    },
    {
        "id": 429589830,
        "type": "file_id",
        "viewable_pages": "1",
        "status": "Ready"
    }
]
Copied to your clipboard
[
    {
        "id": 436651124,
        "type": "job_id",
        "viewable_pages": 0,
        "status": "Completed"
    },
    {
        "id": 429589830,
        "type": "file_id",
        "viewable_pages": "1",
        "status": "Ready"
    }
]

Parameter	Type	Description
`job_id`	`int`	The classifications job ID.

Returns classifications_job_status[], the status of the specified classifications job. Possible values include Waiting for user data, In progress, In progress - % Complete, Completed, Completed - With Errors : <message>. Use the file_id in Classifications.GetExport.

GetTemplate

Similar to the Template tab in the Classifications tool in the Admin Console UI, this retrieves a template to use for importing classifications data.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetTemplate

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetTemplate' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"], "element": 1}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.GetTemplate' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{"rsid_list": ["examplersid"], "element": 1}'

[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "template": "## SC\tSiteCatalyst SAINT Import File\tv:2.0\r\n## SC\t'## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.\r\n## SC\tD:2023-10-24 23:17:15\tA:300162031:1\r\nKey\tSite Section\r\n\r\n"
    }
]
Copied to your clipboard
[
    {
        "rsid": "examplersid",
        "site_title": "Example Site",
        "template": "## SC\tSiteCatalyst SAINT Import File\tv:2.0\r\n## SC\t'## SC' indicates a SiteCatalyst pre-process header. Please do not remove these lines.\r\n## SC\tD:2023-10-24 23:17:15\tA:300162031:1\r\nKey\tSite Section\r\n\r\n"
    }
]

This method requires a JSON body, which includes one or more report IDs to get template for.

Parameter	Type	Description
`rsid_list`	`string`	The report suite where you want to import data.
`element`	`string`	`relation_id` for which you want to get a template (e.g. 101=evar1, 51=product, etc)
`classification_names`	`string[]`	(Optional) an array of text classification names to include as columns in the template.
`encoding`	`string`	(Optional) The encoding to use for the template

Returns classifications_report_suite_template[], the template, or headers in the classifications export file.

PopulateImport

Appends row data to a previously created classifications import job. You can separate data into pages, but the pages must be sent sequentially (either ascending or descending) to avoid errors when the job processes. Individual classifications jobs cannot exceed 25,000 rows.

POST https://api.omniture.com/admin/1.4/rest/?method=Classifications.PopulateImport

Request

Response

curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.PopulateImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "job_id": 436653464,
    "page": 1,
    "rows": [
            {
                "row": [
                    "NC5SAQRLXC",
                    "Retention Resources",
                    "Retention Docs Links",
                    "NC5FRLXC301",
                    "Retention Docs Tag"
                ]
            },
            {
                "row": [
                    "M7K4VSQR2T",
                    "NA_FY20_CM_Analytics New User",
                    "Start First Project",
                    "M7K4SR2T888",
                    "Start First Project video"
                ]
            }
        ]
}'
Copied to your clipboard
curl -X POST 'https://api.omniture.com/admin/1.4/rest/?method=Classifications.PopulateImport' \
-H "x-api-key: {CLIENTID}}" \
-H "Authorization: Bearer {ACCESSTOKEN}" \
-H "Content-Type: application/json" \
-d '{
    "job_id": 436653464,
    "page": 1,
    "rows": [
            {
                "row": [
                    "NC5SAQRLXC",
                    "Retention Resources",
                    "Retention Docs Links",
                    "NC5FRLXC301",
                    "Retention Docs Tag"
                ]
            },
            {
                "row": [
                    "M7K4VSQR2T",
                    "NA_FY20_CM_Analytics New User",
                    "Start First Project",
                    "M7K4SR2T888",
                    "Start First Project video"
                ]
            }
        ]
}'

true
Copied to your clipboard
true

Parameter	Type	Description
`job_id`	`int`	The import job ID where you want to append the row data.
`page`	`int`	A page number that identifies the page's sequential position in the import job. For example, if you submit a spreadsheet with 1000 values, divided into 4 pages, page 1 includes values 1 - 250, page 2 includes values 251 - 500, and so on.
`rows`	`rows`	An array of row data that matches the column heading order of the specified import job.