List Subject Access Requests

1 min

GET

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

Fetch Subject Access Requests submitted from your account

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

Responses

200Return Subject Access Request info

SubjectAccessRequest[]
- account_idinteger<int64>
  Example
  12345
  Description
  The Account ID for the account the Subject Access Request will be executed.
  Format
  int64
- completed_at_timestring<date-time>
  Description
  The time when the request was completed.
  Format
  date-time
- data_typestring<user | visitor>required
  Example
  user
  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
  https://s3-us-west-2.amazonaws.com/optimizely-sar-prod/{account-id}-{request_id}.zip
  Description
  The location to which the data will be exported. The data will be made accessible in a AWS S3 bucket.
- idinteger<int64>
  Example
  12345
  Description
  The Subject Access Request ID.
  Format
  int64
- identifierstringrequired
  Example
  [email protected]
  Description
  The identifier value that you would like us to use when searching. If user was selected in the previous step, the identifier will be the email address for the User.
  Max Length
  355
- identifier_typestring<email | optimizely_end_user_id | dcp_id | fullstack_id | other>required
  Example
  email
  Allowed
  emailoptimizely_end_user_iddcp_idfullstack_idother
- processing_started_timestring<date-time>
  Description
  The time when the processing of the Subject Access Request started.
  Format
  date-time
- request_typestring<access | delete>required
  Example
  access
  Description
  delete - Removes all data within an account that is associated to the identifier defined in the identifier field. access - Finds all data stored in Optimizely systems associated to the identifier defined in the identifier field and exports it to an AWS S3 bucket for you to access.
  Allowed
  accessdelete
- requested_at_timestring<date-time>
  Description
  The time when the Subject Access Request was submitted.
  Format
  date-time
- sla_deadline_timestring<date-time>
  Description
  The time by which the Subject Access Request must be completed.
  Format
  date-time
- statusstring<pending | processing | completed | failure>
  Example
  pending
  Description
  The status of the Subject Access Request.
  Allowed
  pendingprocessingcompletedfailure

400Invalid ID supplied

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

401Invalid credentials

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

403You do not have permission to access the specified subject access request

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

404Subject Access Request not found

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/subject-access-requests?per_page=25&page=1' \
     --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/subject-access-requests?per_page=25&page=1", 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/subject-access-requests?per_page=25&page=1")

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/subject-access-requests?per_page=25&page=1"

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 info
[
  {
    "account_id": 12345,
    "completed_at_time": "",
    "data_type": "user",
    "expired_at_time": "",
    "export_location": "https://s3-us-west-2.amazonaws.com/optimizely-sar-prod/{account-id}-{request_id}.zip",
    "id": 12345,
    "identifier": "[email protected]",
    "identifier_type": "email",
    "processing_started_time": "",
    "request_type": "access",
    "requested_at_time": "",
    "sla_deadline_time": "",
    "status": "pending"
  }
]

400

// Invalid ID supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

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

403

// You do not have permission to access the specified subject access request
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Subject Access Request not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

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