Skip to main content

Data API Documentation

This guide explains how to use the Partner Data API to download partner-specific data.

Overview​

The API allows authenticated clients to retrieve their data in CSV format based on specified date ranges and optional filters. The data is securely processed and hosted on Google Cloud Storage, and a signed URL is provided for download.


API Endpoints​

GET /api/v1/data​

Fetch partner-specific data based on query parameters.

Headers​

HeaderValue
AuthorizationBearer token (API key)

Query Parameters​

ParameterTypeRequiredDescription
start_datestringYesThe starting date (format: YYYY-MM-DD).
end_datestringYesThe ending date (format: YYYY-MM-DD).
websitestringNoOptional filter for a specific website domain.

Example Request​

curl -X GET "https://idprivacy.app/api/v1/data" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d "start_date=2024-12-01&end_date=2024-12-31&website=example.com"