List Subject Access Requests by data source and status

1 min

GET

https://api.optimizely.com/v2/internal-subject-access-requests

Get a list of Subject Access Requests by data source and status

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1
data_sourcestringrequired
Description
Name of the source for which to retrieve the Subject Access Requests
Allowed
app_backendapp_backend_infradata_platformdatawarehouseexternal_systemsoptimizelyoptimizely_on_optimizelyprogram_managementsecuritybusiness_systemsmarketingtse
statusstringrequired
Description
Filter request by status

Responses

200Return Subject Access Request information

SubjectAccessRequestInternal[]
- account_idinteger<int64>
  Description
  Admin account id
  Format
  int64
- completed_at_timestring<date-time>
  Description
  Time when the request was completed
  Format
  date-time
- data_sourcestring<app_backend | app_backend_infra | data_platform | datawarehouse | external_systems | optimizely | optimizely_on_optimizely | program_management | security | business_systems | marketing | tse>required
  Example
  optimizely
  Description
  Subject Access Request Data Source
  Allowed
  app_backendapp_backend_infradata_platformdatawarehouseexternal_systemsoptimizelyoptimizely_on_optimizelyprogram_managementsecuritybusiness_systemsmarketingtse
- data_typestring<user | visitor>required
  Example
  user
  Description
  Subject Access Request Data Type
  Allowed
  uservisitor
- expired_at_timestring<date-time>
  Description
  Time when the url expires (7 days from the completed_at_time)
  Format
  date-time
- export_locationstring
  Example
  s3://{bucket-name}/{account_id}/{parent_sar_id}/{sar_id}
  Description
  The location to which the data will be exported.
- idinteger<int64>
  Example
  12345
  Description
  Subject Access Request ID
  Format
  int64
- identifierstringrequired
  Example
  [email protected]
  Description
  Subject Access Request Identifier
- identifier_typestring<email | optimizely_end_user_id | dcp_id | fullstack_id | other>required
  Example
  email
  Description
  Subject Access Request Identifier Type
  Allowed
  emailoptimizely_end_user_iddcp_idfullstack_idother
- parent_request_idinteger<int64>
  Example
  12345
  Description
  Parent Subject Access Request id
  Format
  int64
- processing_started_timestring<date-time>
  Description
  Time when the processing of the request started
  Format
  date-time
- request_typestring<access | delete>required
  Example
  access
  Description
  Subject Access Request Request Type
  Allowed
  accessdelete
- requested_at_timestring<date-time>
  Description
  Time when the request was submitted
  Format
  date-time
- sla_deadline_timestring<date-time>
  Description
  Time by which the request must be deleted
  Format
  date-time
- statusstring<pending | processing | completed | failure>
  Example
  pending
  Description
  Status of the Subject Access Request
  Allowed
  pendingprocessingcompletedfailure

400Invalid or missing query parameters

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/internal-subject-access-requests?per_page=25&page=1&data_source=app_backend&status=string' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/internal-subject-access-requests?per_page=25&page=1&data_source=app_backend&status=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/internal-subject-access-requests?per_page=25&page=1&data_source=app_backend&status=string")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://api.optimizely.com/v2/internal-subject-access-requests?per_page=25&page=1&data_source=app_backend&status=string"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return Subject Access Request information
[
  {
    "account_id": "",
    "completed_at_time": "",
    "data_source": "optimizely",
    "data_type": "user",
    "expired_at_time": "",
    "export_location": "s3://{bucket-name}/{account_id}/{parent_sar_id}/{sar_id}",
    "id": 12345,
    "identifier": "[email protected]",
    "identifier_type": "email",
    "parent_request_id": 12345,
    "processing_started_time": "",
    "request_type": "access",
    "requested_at_time": "",
    "sla_deadline_time": "",
    "status": "pending"
  }
]

400

// Invalid or missing query parameters
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}