Batch API: Other operations

Website personalisation

Ometria's Batch API for Web Personalisation has additional features to manage uploaded data.

Cancel uploaded data currently processing

A currently running upload can be cancelled by calling the cancel endpoint along with the receipt id provided in the upload stage.

curl --location --request PUT --header 'Authentication: Basic {{APIKEY}}' https://{{domainkey}}.api-{{locationkey}}.ometria.services/batch/cancel/{{receipt}}

Re-process the uploaded content

You can re-process historical data, e.g. to roll back data to a previous state.

Call the reprocess endpoint along with the receipt id provided in the upload stage.

The Batch API will trigger a new processing operation for the historical data.

Pre-requisites:

  • The upload has completed processing.
  • The upload has completed processing with a successful completion state.
  • The uploaded data has not exceeded the Ometria upload data retention policy (minimum of seven days).
curl --location --request PUT --header 'Authentication: Basic {{APIKEY}}' https://{{domainkey}}.api-{{locationkey}}.ometria.services/batch/reprocess/{{receipt}}

Data processing report

All data operations generate a report.

You can download these reports to review the success of an operation and triage any issues with a feed or subsequent downstream processing.

Call the reporting/report endpoint along with the receipt id provided in the upload stage.

The Batch API will return a JSON report.

Pre-requisites:

  • The upload has completed processing.
curl --location --request GET --header 'Authentication: Basic {{APIKEY}}' https://{{domainkey}}.api-{{locationkey}}.ometria.services/reporting/report/{{receipt}}

Download copy of uploaded data

All data uploads are retained for a minimum of seven days.

You can manually download these uploads for review.

This can be useful alongside the data processing report to triage any data processing issues for uploaded content generated by an automated process.

Call the export/upload_data endpoint along with the receipt id provided in the upload stage.

The Batch API downloads a copy of the original data you sent.

Pre-requisites:

The data has been successfully uploaded.

The uploaded data has not exceeded the Ometria upload data retention policy (minimum of seven days).

curl --location --request GET --header 'Authentication: Basic {{APIKEY}}' https://{{domainkey}}.api-{{locationkey}}.ometria.services/export/batch/{{receipt}}