Retrieve Snap statistics

Retrieve the Snap statistics data, which includes the number of pipelines impacted, pipeline names, full project paths, and Environment names. This helps the user consolidate and analyze data across all organizations for adoption reporting and impact analysis.

GET https://{controlplane_path}/api/1/rest/public/stats/snap_stats/{path}{query_parameters}

Retrieve the Snap statistics data, which includes the number of pipelines impacted, pipeline names, full project paths, and Environment names.

Prerequisites

Environment (Org) admin permissions

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.snaplogic.com` `emea.snaplogic.com`
`project path`	Required. The path to the SnapLogic project. Valid formats: `/{env_org}` or `/{env_org}/{project_space}` or `/{env_org}/{project_space}/{project_name}`

Query parameters


Parameter	Description	Required
`snappack_label`	The name of the Snap pack.	No
`snap_label`	The name of the Snap.	No

Important: There's no error message if the snap_label is invalid, the respective result will be empty. However if only the snap_label is specified, an exception is raised.

Response body

A successful response retrieves the Snap statistics. This response is retrieved without specifying the query parameters:


{
"org_name": "OrgName"
  {
    "snapPackName": "MySQL",
    "snapPackType": "Premieum",
    "snapNames": ["MySQL Read", "MySQL Write", ...],
    "totalpipelineCount": 10,
    "snaps": [
      {
        "snapName": "MySQL Read",
        "pipelineCount": 2,
        "pipelines": [  
          {
            "pipelineName": "ETL Pipeline",
            "pipelinePath": "/pipelines/etl",
            "pipelineUrl": "https://example.com/pipelines/etl"
          },
          {
            "pipelineName": "Data Sync",
            "pipelinePath": "/pipelines/etl",
            "pipelineUrl": "https://example.com/pipelines/etl"
          }
        ]
      },  
      {
        "snapName": "MySQL Write",
        "pipelineCount": 1,
        "pipelines": [
          {
            "pipelineName": "Data Batch",
            "pipelinePath": "/pipelines/batch",
            "pipelineUrl": "https://example.com/pipelines/batch"
          }
        ]
      }
    ]
  },
    {
      "snapPackName": "PostGreSQL",
      "snapPackType": "Public",
      "snapNames": ["PostGreSQL Read"],
      "totalpipelineCount": 2,
      "snaps": [
        {
          "snapName": "PostGreSQL Read",
          "pipelineCount": 2,
          "pipelines": [  
            {
              "pipelineName": "Replication Pipeline",
              "pipelinePath": "/pipelines/synch",
              "pipelineUrl": "https://example.com/pipelines/synch"
            },
            {
              "pipelineName": "Replication Child Pipeline",
              "pipelinePath": "/pipelines/synch/child",
              "pipelineUrl": "https://example.com/pipelines/synch"
            },
          ]
        }
      ]
    }
}

Example 1

If we specify the snappack_label as MySQL.


{
  "snapPackName": "MySQL",
  "snapPackType": "Premieum",
  "snapNames": ["MySQL Read", "MySQL Write", ...],
  "totalpipelineCount": 10,
  "snaps": [
    {
      "snapName": "MySQL Read",
      "pipelineCount": 2,
      "pipelines": [  
        {
          "pipelineName": "ETL Pipeline",
          "pipelinePath": "/pipelines/etl",
          "pipelineUrl": "https://example.com/pipelines/etl"
        },
        {
          "pipelineName": "Data Sync",
          "pipelinePath": "/pipelines/etl",
          "pipelineUrl": "https://example.com/pipelines/etl"
        }
    ]
   },  
   {
    "snapName": "MySQL Write",
    "pipelineCount": 1,
    "pipelines": [
     {
       "pipelineName": "Data Batch",
       "pipelinePath": "/pipelines/batch",
       "pipelineUrl": "https://example.com/pipelines/batch"
     }
    ]
   }
 ]
}

Example 2

If we specify the snappack_label as MySQL and snap_label as MySQL - Select


{
  "org_name": "snaplogic",
  "snap_stats": {
  "MySQL": {
    "snap_pack_label": "MySQL",
    "snap_pack_access_type": "premium",
    "class_build_tag": "SNAPSHOT",
    "snap_labels": [
      "MySQL - Select"
      ],
    "total_pipeline_count": 4,
    "snaps": [
      {
        "snap_label": "MySQL - Select",
        "class_id": "com-snaplogic-snaps-mysql-select",
        "pipeline_count": 4,
        "pipelines": [
           {
             "pipeline_name": "HelloPipe",
             "pipeline_url": "http://localhost:8888/sl/designer.html#pipe_snode=673ce02466302886dad42e53",
             "pipeline_path": "/snaplogic/git_folder_test1/test_project/HelloPipe"
           },
          {
            "pipeline_name": "HelloPipe",
            "pipeline_url": "http://localhost:8888/sl/designer.html#pipe_snode=673ce022da5b4293ba2e9185",
            "pipeline_path": "/snaplogic/git_folder_test1/shared/HelloPipe"
          },
          {
            "pipeline_name": "HelloPipe",
            "pipeline_url": "http://localhost:8888/sl/designer.html#pipe_snode=677ef6e4ff129baca3c78dd2",
            "pipeline_path": "/snaplogic/STUD-52/test_project/HelloPipe"
          },
          {
            "pipeline_name": "HelloPipe",
            "pipeline_url": "http://localhost:8888/sl/designer.html#pipe_snode=673ce024da5b4293ba2e919c",
            "pipeline_path": "/snaplogic/git_folder_test1/root/HelloPipe"
          }
         ]
        }
       ]
      }
     }
    }