Retrieve Request Details using Type and Subtype

get

https://{host}/v2/requests

Allows you to retrieve request details with desired filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Request

curl: https://{host}/v2/requests

Example: https://eu.api.capillarytech.com/v2/requests?requestType=CUSTOMER&requestSubType=DELETE&limit=10&offset=0&sort=ADDED_ON&order=DESC&source=WEB_ENGAGE

Response

type: Displays the PII deletion request data type.
baseType: Displays the PII deletion request action.
status: Displays the PII deletion request status.
attribution: Displays the attribution details of the PII deletion request data.
id: Displays the PII deletion request ID.
customerDeletionDetails: Displays the PII deletion request and scheduled time and status of the request.

Query Params

requestType

string

required

Type of request. Values: TRANSACTION - For transaction request CHANGE_IDENTIFIER - For customer merge request

requestSubType

string

required

Subtype of the request. Values: REGULAR_TXN_ADD - For transaction request MERGE - For customer merge request

limit

int32

umber of results. For example, number 10 retrieves the first 10 rows of the query results.

offset

string

Defines the number of rows that needs to be skipped from the beginning of the results. For example, number 10 skips the first 10 search results.

sort

string

enum

Sorts the results as per the defined method.

Allowed:

order

string

Sorts the data in descending or ascending order.

status

string

enum

Filter the data by its status.

Allowed:

Customer identification

object

required

Customer identification parameters such as source, account id, identifiers etc.

start_date

date

Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z.

end_date

date

Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z.

Responses

Request

Response

200200

400400