Retrieve concurrent and daily execution metrics
GET /runtime/api-stats/{env_org}?{query_parameters}
Overview
This API retrieves the concurrent and daily metrics of pipeline executions at the specified time.
Prerequisites
- Org admin (Environment admin) permissions
Request
GET https://{pod_path}/api/1/rest/public/runtime/api-stats/{env_org}?{query_parameters}
Path Parameters
Key | Description |
---|---|
pod_path |
Required. The path to your SnapLogic pod.
Example: |
org |
Required. The name of the SnapLogic Environment/Org. |
Query Parameters
Key | Type | Description |
---|---|---|
date_time |
string | The time in UTC format.
Default: The current time. Example: |
Request Header
Specify Basic
for authorization and application/json
for content type.
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
None.
Response
Response Body
Note:
The results include only the pipeline executions that you have permissions to view.
Environment/Org admins can view all pipeline executions.
{
"response_map": {
"organization": "...",
"daily_limit": ...,
"daily_call_used": ...,
"concurrent_limit": ...,
"concurrent_call_in_progress": ...
},
"http_status_code": 200
}
Key | Type | Description |
---|---|---|
organization |
string | The name of the SnapLogic Environment/Org. |
daily_limit |
integer | The maximum number of pipeline executions that the Environment/Org is allowed in a day. |
daily_call_used |
integer | The number of pipeline executions that were executed in the current day. |
concurrent_limit |
integer | The maximum number of concurrent pipeline executions that the Environment/Org is allowed. |
concurrent_call_in_progress |
integer | The number of pipeline executions that are concurrently in progress. |
Examples
- To retrieve the concurrent and daily metrics for API usage for today,
GET https://elastic.snaplogic.com/api/1/rest/public/runtime/api-stats/myEnvOrg