{ "opencollection": "1.0.0", "info": { "name": "Adobe Analytics Classification API", "version": "v1" }, "items": [ { "info": { "name": "Classification Dataset", "type": "folder" }, "items": [ { "info": { "name": "Get one classification dataset", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/datasets/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Classification Dataset ID" } ] }, "docs": "Get one classification dataset by dataset id" }, { "info": { "name": "Save change on one classification dataset", "type": "http" }, "http": { "method": "PUT", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/datasets/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Classification Dataset ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Save change on one classification dataset by dataset id" }, { "info": { "name": "Delete one classification dataset", "type": "http" }, "http": { "method": "DELETE", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/datasets/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Classification Dataset ID" } ] }, "docs": "Delete one classification dataset by dataset id, all classification data will be deleted as well" }, { "info": { "name": "Get compatibility metrics for a given report suite", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/datasets/compatibilityMetrics/:rsid", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsid", "value": "", "type": "path", "description": "Adobe Analytics report suite ID" } ] }, "docs": "Get compatibility metrics and the dataset id that associated with the metrics for a given report suite" }, { "info": { "name": "Retrieve dataset template", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/datasets/template/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Classification Dataset ID" }, { "name": "format", "value": "", "type": "query", "description": "Template format" } ] }, "docs": "Retrieve dataset template for a given dataset id" } ] }, { "info": { "name": "Classification Job", "type": "folder" }, "items": [ { "info": { "name": "Commit API import job for processing", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/import/commitApiJob/:api_job_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "api_job_id", "value": "", "type": "path", "description": "The API Job Id for uploading file" } ] }, "docs": "Commit API import job for processing" }, { "info": { "name": "Create API import job entity on classification dataset", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/import/createApiJob/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The dataset id for creating import job" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create API import job entity on classification dataset, need to upload file after this API call" }, { "info": { "name": "Create export job for one dataset", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/export/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The dataset id for creating API export job" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create export job for one dataset, the row limit should be less than 50,000" }, { "info": { "name": "Create API import job classification dataset with JSON format data", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/import/json/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The dataset id for creating API import job" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create API import job classification dataset with JSON format data, the JSON data size should be less than 50MB" }, { "info": { "name": "Retrieve classification jobs for specified dataset", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/byDataset/:dataset_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Classification Dataset ID" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Look back Windows (Days)" }, { "name": "page", "value": "", "type": "query", "description": "The page number" }, { "name": "size", "value": "", "type": "query", "description": "The page size" } ] }, "docs": "Retrieve classification jobs for specified dataset" }, { "info": { "name": "Retrieve classification job by job ID", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/:job_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "job_id", "value": "", "type": "path", "description": "Classification Job ID" } ] }, "docs": "Retrieve classification job by job ID" }, { "info": { "name": "Retrieve export file by export job ID ", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/export/file/:job_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "job_id", "value": "", "type": "path", "description": "Export Job ID" } ] }, "docs": "Retrieve export file by export job ID" }, { "info": { "name": "Retrieve export file by export job ID and file name", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/export/file/:job_id/:file_name", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "job_id", "value": "", "type": "path", "description": "Export Job ID" }, { "name": "file_name", "value": "", "type": "path", "description": "File Name" } ] }, "docs": "Retrieve export file by export job ID and file name" }, { "info": { "name": "Retrieve export file list by export job ID ", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/export/file/:job_id/list", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "job_id", "value": "", "type": "path", "description": "Export Job ID" } ] }, "docs": "Retrieve export file list by export job ID" }, { "info": { "name": "Upload File for API import job", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.adobe.io/api/:globalCompanyId/classification/job/import/uploadFile/:api_job_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "api_job_id", "value": "", "type": "path", "description": "The API Job Id for uploading file" } ] }, "docs": "Upload File for one API import job, the file size limit is 50MB" } ] } ], "bundled": true }