SparQDocs
GuidesAPI referencesparqhq.ai
API referenceObservability

Run Destination Test

POST
/v1/admin/trace-destinations/{destination_id}/test

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

destination_id*Destination Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Response Body

Successful Response

application/json
  1. response
destination_id*Destination Id
Formatuuid
ok*Ok
latency_ms*|null
error*string|null
tested_at*Tested At
Formatdate-time
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/trace-destinations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test'
Example Response
{  "destination_id": "f73cdd0c-5b5d-4102-9dde-c2ec04ceba9e",  "ok": true,  "latency_ms": 0,  "error": "string",  "tested_at": "2019-08-24T14:15:22Z"}

Remove Trace Destination DELETE

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

Usage Report GET

Usage grouped by up to three dimensions. Client admins see only their own client.