Customer data job status¶

GDPR compliance feature

The customer data job status is part of Voyado's solutions for enabling GDPR compliance concerning data managed by Voyado Elevate 3.

The customer data job status can be performed to check the current job status of an export or removal job.

A jid argument is supplied to return the job status of the export or removal job queried. The jid is also returned in the response.

When executing queries with the GDPR API, an Api-Key header is required for authentication.

Method¶

GET

URL format¶

/api/v2/event-data/job-status?jid={jid}

Parameters¶

Name	Type	Description	Example
`jid`	string	Unique id generated for an export or removal job.	`ca24b4e...247837a`

Request body¶

Not applicable

Request content-type¶

Not applicable

Response content-type¶

application/json

Responses¶

A response will always return a job status.

Response statuses¶

Status	Description
`created`	The export or remove job is started.
`done`	The export or remove job is completed.
`not_found`	There is no export or remove job with the given job id, `jid`.
`running`	The export or remove job is in progress.
`waiting`	The export or remove job has not started. All jobs will wait until the day after they are created before they run.

Examples¶

Request¶

cURL¶

#!/bin/bash
curl -i \
-X GET \
-H "Api-Key: {PRIVATE-KEY}" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/event-data/job-status?jid=ca24b4e2-34ab-406a-a4db-b30b0247837a"

Response¶

{
  "jid": "ca24b4e2-34ab-406a-a4db-b30b0247837a",
  "status": "waiting"
}