Job endpoints

The Job endpoint allows you to create a Data Repair API job (using POST) or retrieve a list of your currently running jobs (using GET).

data-variant=info

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

Create a Data Repair API job

data-variant=warning

data-slots=text
Use of the Data Repair API permanently deletes or edits your Adobe Analytics data. See the Overview page for the recommended workflow to mitigate accidental deletion or alteration of your data.

POST https://analytics.adobe.io/api/{GLOBALCOMPANYID}/datarepair/v1/{RSID}/job

This endpoint requires multiple components:

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

Request

curl -X POST \
  -H "accept: application/json" \
  -H "content-type: application/json" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {CLIENTID}" \
  -d '{"variables": {"ipaddress": {"action": "delete"}}}' \
  "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/datarepair/v1/examplersid/job?validationToken={VALIDATION_TOKEN}&dateRangeStart=YYYY-03-28&dateRangeEnd=YYYY-03-29"

Response

{
  "dateRangeEnd": "YYYY-03-28",
  "dateRangeStart": "YYYY-03-29",
  "jobCompleteTime": null,
  "jobCreateTime": "YYYY-04-24T09:02:59+00:00",
  "jobDefinition": {
    "variables": {
      "ipaddress": {
        "action": "delete"
      }
    }
  },
  "jobId": 24,
  "progress": 0,
  "reportSuiteId": "examplersid",
  "serverCalls": 100,
  "status": "processing"
}

The validationToken is consumed when you create a data repair job. You must use the Server Call estimate endpoint to generate a new validationToken to call this endpoint again.

View a Data Repair API job list

Use this endpoint to retrieve a list of your most recent 20 data repair jobs for the given Report Suite. It includes both currently running and completed jobs.

GET https://analytics.adobe.io/api/{COMPANY_ID}/datarepair/v1/{RSID}/job

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

Request

curl -X GET "https://analytics.adobe.io/api/exampleco/datarepair/v1/examplersid/job" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY/CLIENT_ID}"

Response

[
  {
    "dateRangeEnd": "YYYY-03-28",
    "dateRangeStart": "YYYY-03-28",
    "jobCompleteTime": "YYYY-04-24T10:13:51+00:00",
    "jobCreateTime": "YYYY-04-24T09:02:59+00:00",
    "jobDefinition": {
      "variables": {
        "activitymap": {
          "action": "delete"
        },
        "prop12": {
          "action": "delete"
        },
        "evar74": {
          "action": "delete"
        },
        "evar107": {
          "action": "delete"
        }
      }
    },
    "jobId": "24",
    "progress": 100,
    "reportSuiteId": "examplersid",
    "serverCalls": 2,
    "status": "complete"
  },
  {
    "dateRangeEnd": "YYYY-04-24",
    "dateRangeStart": "YYYY-04-24",
    "jobCompleteTime": null,
    "jobCreateTime": "YYYY-05-18T09:02:59+00:00",
    "jobDefinition": {
      "variables": {
        "prop82": {
          "action": "delete"
        }
      }
    },
    "jobId": "25",
    "progress": 0,
    "reportSuiteId": "examplersid",
    "serverCalls": 2,
    "status": "processing"
  }
]

View an individual Data Repair API job

You can call the /job/{JOB_ID} endpoint to check on the progress of a data repair job. Following submission of a job, status reports as processing and progress is a number between 0 and 100. Once complete, status reports as complete and serverCalls is set to the number of Data Rows Scanned during the job. This serverCalls value is used to calculate usage.

Completion of your data repair job can take hours to days, depending on the date range of the data repair job and the amount of traffic the Report Suite gets per day.

GET https://analytics.adobe.io/api/{GLOBALCOMPANYID}/datarepair/v1/{RSID}/job/{JOB_ID}

data-slots=heading, code

data-repeat=2

data-languages=CURL,JSON

Request

curl -X GET "https://analytics.adobe.io/api/exampleco/datarepair/v1/examplersid/job/24" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY/CLIENT_ID}"

Response

{
  "dateRangeEnd": "YYYY-01-28",
  "dateRangeStart": "YYYY-01-28",
  "jobCompleteTime": "YYYY-03-24T10:13:51+00:00",
  "jobCreateTime": "YYYY-03-24T09:02:59+00:00",
  "jobDefinition": {
    "variables": {
      "activitymap": {
        "action": "delete"
      },
      "prop12": {
        "action": "delete"
      },
      "evar74": {
        "action": "delete"
      },
      "evar107": {
        "action": "delete"
      }
    }
  },
  "jobId": "24",
  "progress": 100,
  "reportSuiteId": "examplersid",
  "serverCalls": 2,
  "status": "complete"
}