SparQDocs
GuidesAPI referencesparqhq.ai
API referenceObservability

Call Location

GET
/v1/admin/usage/{usage_id}/location

Where one call ran, and why (the routing decision).

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

usage_id*Usage 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

Response Body

Successful Response

application/json
  1. response

Where one call ran, and why (GET /v1/admin/usage/{usage_id}/location, 15.7).

usage_id*Usage Id
Formatuuid
run_id*|null
provider*|null
deployment*string|null
region*string|null
occurred_at*Occurred At
Formatdate-time
routing*|null
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/usage/497f6eca-6276-4993-bfeb-53cbbbba6f08/location'
Example Response
{  "usage_id": "fb86d280-0604-4bf0-8407-74c68cfb319d",  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",  "provider": "string",  "deployment": "string",  "region": "string",  "occurred_at": "2019-08-24T14:15:22Z",  "routing": {    "compliance_profile_version": 0,    "rules_applied": [      "string"    ],    "removed": [      {        "deployment": "string",        "reason": "string"      }    ],    "chosen_deployment": "string",    "region": "string",    "fallback_used": true  }}

Add Trace Destination POST

> **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.

Get Run Envelope GET

> **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. The context envelope a run used, to explain why a feature or tool was on or off.