Test a destination | Pivolio Docs

Sends a sample event to verify a destination's credentials, using the provided ones or the saved ones.

Authentication

X-Workspace-Idstring

API Key authentication via header

Path parameters

platformenumRequired

Ad platforms. The subset with a destination adapter is dispatchable for CAPI (incl. Reddit); the rest (e.g. x) appear only as click sources.

Request

This endpoint expects an object.

credentialsmap from strings to strings or nullOptional

test_event_codestring or nullOptional

Response

Successful Response

successboolean

status_codeinteger

error_codeenum or nullOptional

Why a delivery failed.

The HTTP status is reported separately; these classify the cause, so a caller never has to parse an error string. A skipped delivery has no error code — it did not fail, it was never sent.

error_messagestring or nullOptional

request_idstring or nullOptional

noteslist of stringsOptional

Errors

422

Unprocessable Entity Error

$	curl -X POST /destinations/meta/test \
>	-H "X-Workspace-Id: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"success": true,
3	"status_code": 1,
4	"error_code": "TRANSFORM_ERROR",
5	"error_message": "string",
6	"request_id": "string",
7	"notes": [
8	"string"
9	]
10	}