PingPlotter Cloud Manual

LiveShares

Overview

LiveShare links allow you to share web links to live-updating PingPlotter results.

  • LinkType: this field refers to the type of link you want to create. You can create LiveShare links for an agent, session, or summary.
  • EntityId: this is the Id of the Agent or Session for which you are creating the link. This Id must match the corresponding type set in the LinkType.

GET

GET /liveshares

Retrieve all LiveShare links.

curl -X 'GET' \
   'https://yoursubdomain.api.pingplotter.cloud/liveshares' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token'

200 Response

[
    {
        "ShareId": "string",
        "ShareUrl": "string",
        "Description": "string",
        "Notes": "string",
        "Active": true,
        "CreationDate": "2025-11-06T18:52:32.028Z",
        "ExpirationDate": "2025-11-06T18:52:32.028Z",
        "CreatedBy": "string",
        "LinkType": "string",
        "EntityId": "string"
    }
]

POST

POST /liveshares

Create a new LiveShare link.

curl -X 'POST' \
'https://yoursubdomain.api.pingplotter.cloud/liveshares' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_token'
-d '{
    "LinkType": "string",
    "EntityId": "string",
    "Description": "string",
    "Notes": "string",
    "ExpirationDate": "2025-11-06T18:56:43.997Z"
}'

200 Response

[
    {
        "ShareId": "string",
        "ShareUrl": "string",
        "Description": "string",
        "Notes": "string",
        "Active": true,
        "CreationDate": "2025-11-06T18:52:32.028Z",
        "ExpirationDate": "2025-11-06T18:52:32.028Z",
        "CreatedBy": "string",
        "LinkType": "string",
        "EntityId": "string"
    }
]

Request Body

Key Type Notes
LinkType string Required. Options: agent, session, summary
EntityId string Required. Id of the agent, session, or summary
Description string Name of the LiveShare, e.g. Broken Route
Notes string Notes about the LiveShare, e.g. Case #00001
ExpirationDate string ISO Date/Time the LiveShare link will automatically expire. Note: Do not include to keep link active until manually disabled. 
POST /liveshares/GetAllLiveSharesWithFilter

Retrieve LiveShare links using a filter.

curl -X 'POST' \
'https://yoursubdomain.api.pingplotter.cloud/liveshares/GetAllLiveSharesWithFilter/?linkType="agent"' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_token'
-d '[
    "string"
]'

200 Response

[
    {
        "ShareId": "string",
        "ShareUrl": "string",
        "Description": "string",
        "Notes": "string",
        "Active": true,
        "CreationDate": "2025-11-06T18:52:32.028Z",
        "ExpirationDate": "2025-11-06T18:52:32.028Z",
        "CreatedBy": "string",
        "LinkType": "string",
        "EntityId": "string"
    }
]

Request Body

Key Type Notes
string array List of EntityId's to filter down to. Must match Entity must match link type.

Query Parameters

Parameter Type Notes
linkType string Required. Options: agent, session, summary

PUT

PUT /liveshares/{shareId}

Edit an existing LiveShare link.

curl -X 'PUT' \
'https://yoursubdomain.api.pingplotter.cloud/liveshares/{shareId}' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_token'
-d '{
    "Description": "string",
    "Notes": "string",
    "Active": true,
    "ExpirationDate": "2025-11-06T19:10:32.920Z",
    "LinkType": "string",
    "EntityId": "string"
}'

200 Response

[
    {
        "ShareId": "string",
        "ShareUrl": "string",
        "Description": "string",
        "Notes": "string",
        "Active": true,
        "CreationDate": "2025-11-06T18:52:32.028Z",
        "ExpirationDate": "2025-11-06T18:52:32.028Z",
        "CreatedBy": "string",
        "LinkType": "string",
        "EntityId": "string"
    }
]

Request Body

Key Type Notes
LinkType string Options: agent, session, summary
EntityId string Id of the agent, session, or summary
Description string Name of the LiveShare, e.g. Broken Route
Notes string Notes about the LiveShare, e.g. Case #00001
ExpirationDate string ISO Date/Time the LiveShare link will automatically expire. Note: Do not include to keep link active until manually disabled.

DELETE

DELETE /liveshares/{shareId}

Delete a LiveShare link.

curl -X 'DELETE' \
   'https://yoursubdomain.api.pingplotter.cloud/liveshares/{shareId}' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token'

200 Response

true