Create a Retrieval

Creates a data retrieval job.

POST /data-retrievals/v3.0

Create a Retrieval

cURL

curl --request POST \
  --url https://{regionAndDomain}.com/api/app/data-retrievals/v3.0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distinct_ids": [
    "distinct_id_1",
    "distinct_id_2",
    "distinct_id_3"
  ],
  "compliance_type": "<string>",
  "disclosure_type": "<string>"
}
'

import requests

url = "https://{regionAndDomain}.com/api/app/data-retrievals/v3.0"

payload = {
    "distinct_ids": ["distinct_id_1", "distinct_id_2", "distinct_id_3"],
    "compliance_type": "<string>",
    "disclosure_type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    distinct_ids: ['distinct_id_1', 'distinct_id_2', 'distinct_id_3'],
    compliance_type: '<string>',
    disclosure_type: '<string>'
  })
};

fetch('https://{regionAndDomain}.com/api/app/data-retrievals/v3.0', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{regionAndDomain}.com/api/app/data-retrievals/v3.0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'distinct_ids' => [
        'distinct_id_1',
        'distinct_id_2',
        'distinct_id_3'
    ],
    'compliance_type' => '<string>',
    'disclosure_type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{regionAndDomain}.com/api/app/data-retrievals/v3.0"

	payload := strings.NewReader("{\n  \"distinct_ids\": [\n    \"distinct_id_1\",\n    \"distinct_id_2\",\n    \"distinct_id_3\"\n  ],\n  \"compliance_type\": \"<string>\",\n  \"disclosure_type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{regionAndDomain}.com/api/app/data-retrievals/v3.0")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"distinct_ids\": [\n    \"distinct_id_1\",\n    \"distinct_id_2\",\n    \"distinct_id_3\"\n  ],\n  \"compliance_type\": \"<string>\",\n  \"disclosure_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{regionAndDomain}.com/api/app/data-retrievals/v3.0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"distinct_ids\": [\n    \"distinct_id_1\",\n    \"distinct_id_2\",\n    \"distinct_id_3\"\n  ],\n  \"compliance_type\": \"<string>\",\n  \"disclosure_type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "status": "ok",
  "results": {
    "task_id": "job-tracking-id"
  }
}

{
  "error": "<string>",
  "status": "error"
}

{
  "error": "<string>",
  "status": "error"
}

Authorizations

Authorization · string · header · required

OAuth Token

Query Parameters

token · string · required

Your project token

Body

application/json

distinct_ids · string[]

Distinct IDs involved in the request

Example:

[
  "distinct_id_1",
  "distinct_id_2",
  "distinct_id_3"
]

compliance_type · string

Select CCPA or GDPR. Default is GDPR.

disclosure_type · string

Only required if compliance_type = CCPA. Can be Data, Categories, or Sources. Default is Data.

Response

201

application/json

Success

A JSON response object containing the task_id of the retrieval/deletion job.

status · string · required

The status of the response

Example:

"ok"

results · object · required

Show child attributes