Retrieve concurrent execution metrics

GET /runtime/api-stats/{env_org}/concurrent?{query_parameters}

Overview

This API retrieves the metrics of concurrent pipeline executions at the specified time.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 GET https://{controlplane_path}/api/1/rest/public/runtime/api-stats/{env_org}/concurrent?{query_parameters}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
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: date_time=2021-12-31T01:01:01

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": "...",
    "time_stamp": "...",
    "concurrent_call_in_progress": ...,
    "tasks": [
      {
        "task_id": "...",
        "task_name": "...",
        "task_path": "...",
        "task_owner": "...",
        "api_count": ...
      }
    ]
  },
  "http_status_code": 200
}
Key Type Description
organization string The name of the SnapLogic Environment/Org.
time_stamp string The timestamp when the statistics were collected.

Format: UTC

concurrent_call_in_progress integer The number of pipeline executions that are concurrently in progress.
tasks array An array of objects containing metadata about each task.