GuidesSupport
DocumentationCookie ConsentMapsTag ManagerTranslation WidgetHeatmapsPlatformIngest

Destinations

Manage where your data is sent. Create, list, update, and delete destinations in your account.

GET
/rest/v1/destinations

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/destinations"
{
  "entities": [
    {
      "id": "string",
      "name": "string",
      "type": "AWSEventBridge",
      "status": "Disabled",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
POST
/rest/v1/destinations

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Request Body

application/json

name?|
type*string
Value in"AWSEventBridge" | "AWSKinesis" | "AWSLambda" | "AWSS3" | "AWSSNS" | "ActiveCampaignApi" | "AmazonDSP" | "Amplitude" | "AppLovin" | "ArtsAI" | "Audiohook" | "AzureBlob" | "BasisPostback" | "BingAds" | "BingAdsWeb" | "Braze" | "ConvertABTestingEvent" | "Customerio" | "DomoWarehouse" | "Facebook" | "FullContact" | "G4Analytics" | "GA4MeasurementProtocol" | "GA4ServerProxy" | "Google" | "GoogleAds360" | "GoogleAdsServerContainer" | "GoogleBigQuery" | "GoogleBigQueryWarehouse" | "GoogleDataManagerEventIngest" | "GooglePubSub" | "GoogleStorage" | "HTTPCustomRequest" | "HTTPDestination" | "Hubspot" | "IHeartMediaMagellan" | "Impact" | "Iterable" | "Klaviyo" | "LinkedInAdsCAPI" | "LiveIntent" | "LiveRampWarehouse" | "Mailchimp" | "Mixpanel" | "NextdoorAds" | "OursSyntheticData" | "Partnerize" | "Pinterest" | "Podscribe" | "QuantcastCAPI" | "QuoraAds" | "Reddit" | "SnapchatAdsCapi" | "Spotify" | "StackAdaptAPI" | "Taboola" | "Tatari" | "TheTradeDesk" | "TikTok" | "Viant" | "Vibe" | "Woopra" | "XAds" | "Zendesk" | "ZoomInfo"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.oursprivacy.com/rest/v1/destinations" \  -H "Content-Type: application/json" \  -d '{    "type": "AWSEventBridge"  }'
{
  "id": "string",
  "name": "string",
  "type": "AWSEventBridge",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/destinations/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/destinations/string"
{
  "id": "string",
  "name": "string",
  "type": "AWSEventBridge",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
PATCH
/rest/v1/destinations/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Request Body

application/json

status*string
Value in"Disabled" | "Enabled"
name?|
facebookConversionAPIKey?|
facebookPixelId?|
g4AnalyticsApiKey?|
g4AnalyticsMeasurementId?|
g4AnalyticsTrackOnPage?|
hashingSalt?|
httpDestinationUrl?|
limitedToSourceIds?array<>|
managerGoogleCustomerId?|
projectAPIKey?|
projectToken?|
selectedAccountId?|
settings?|

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.oursprivacy.com/rest/v1/destinations/string" \  -H "Content-Type: application/json" \  -d '{    "status": "Disabled"  }'
{
  "id": "string",
  "name": "string",
  "type": "AWSEventBridge",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
DELETE
/rest/v1/destinations/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.oursprivacy.com/rest/v1/destinations/string"
true
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}

How is this guide?

Quickstart

Previous Page

Sources

Next Page