Skip to Content

Get Samply Profile

GET/v0/pipelines/{pipeline_name}/samply_profile
Authentication
Parameters

Retrieve the last samply profile of a pipeline, regardless of whether profiling is currently in progress. If ?latest parameter is specified and Samply profile collection is in progress, returns HTTP 307 with Retry-After header.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Query parameters

NameTypeRequiredDescription
ordinalintegerNoIn a multihost pipeline, the ordinal of the pipeline to sample.
latestbooleanNoIf true, returns 204 redirect with Retry-After header if profile collection is in progress. If false or not provided, returns the last collected profile.

Response

application/gzip
Samply profile as a gzip containing the profile that can be inspected by the samply tool. Note: may return 204 No Content with Retry-After header if latest=true and profiling is in progress.
  • string (binary)
Request
curl -X GET '/v0/pipelines/{pipeline_name}/samply_profile?ordinal=%3Cordinal%3E&latest=%3Clatest%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
Samply profile as a gzip containing the profile that can be inspected by the samply tool. Note: may return 204 No Content with Retry-After header if latest=true and profiling is in progress.
"string"