v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB

Subject Access Requests

List Subject Access Requests

Fetch Subject Access Requests submitted from your account

get/subject-access-requests

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

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.

Response

Return Subject Access Request info

account_idinteger

The Account ID for the account the Subject Access Request will be executed.

completed_at_timestring date-time nullable

The time when the request was completed.

data_type'user' | 'visitor' required

The type of data to be accessed or deleted. The two options are: <ul> <li><code>user</code> - End users (also known as Collaborators) that are added to the accounts of our customers. A user can be a <a href="https://help.optimizely.com/Set_Up_Optimizely/Manage_collaborators_in_Optimizely_X" rel="internal">collaborator</a> on multiple accounts.</li> <li><code>visitor</code> - Visitors who visit or use our customers’ websites, apps and other digital products. Optimizely stores visitor data to calculate experiment results and to tailor content.</li> </ul>

expired_at_timestring date-time

Time when the url expires (7 days from the completed_at_time)

export_locationstring

The location to which the data will be exported. The data will be made accessible in a AWS S3 bucket.

idinteger

The Subject Access Request ID.

identifierstring required

The identifier value that you would like us to use when searching. If <code>user</code> was selected in the previous step, the identifier will be the email address for the User.

identifier_type'email' | 'optimizely_end_user_id' | 'dcp_id' | 'fullstack_id' | 'other' required

User data is identified by the email address used to create the end user account. The endpoint only accepts the <code>email</code> datatype if you selected <code>user</code> for Datatype. If you selected <code>visitor</code> for data_type, you can select 5 options for personal identifier types: <ul> <li> <code>dcp_id</code> - Any ID used to identify targeting records in Optimizely. </li> <li> <code>email</code> - The email address of a visitor. </li> <li> <code>fullstack_id</code> - The unique identifier used for Full Stack experiments. </li> <li> <code>optimizely_end_user_id</code> - An Optimizely generated user cookie. </li> <li> <code>other</code> - Any other identifier that was uploaded to Optimizely. </li> </ul>

processing_started_timestring date-time nullable

The time when the processing of the Subject Access Request started.

request_type'access' | 'delete' required

<code>delete</code> - Removes all data within an account that is associated to the identifier defined in the identifier field. <code>access</code> - 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.

requested_at_timestring date-time

The time when the Subject Access Request was submitted.

sla_deadline_timestring date-time nullable

The time by which the Subject Access Request must be completed.

status'pending' | 'processing' | 'completed' | 'failure'

The status of the Subject Access Request.

Example response

[
  {
    "account_id": 12345,
    "data_type": "user",
    "export_location": "https://s3-us-west-2.amazonaws.com/optimizely-sar-prod/{account-id}-{request_id}.zip",
    "id": 12345,
    "identifier": "test@optimizely.com",
    "identifier_type": "email",
    "request_type": "access",
    "status": "pending"
  }
]