GET
/
v2
/
workspaces
/
{workspaceId}
/
usage
curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage \
  --header 'X-Prismeai-API-Key: <api-key>'
{
  "workspaceId": "<string>",
  "beforeDate": "<string>",
  "afterDate": "<string>",
  "interval": "<string>",
  "total": {
    "transactions": 123,
    "httpTransactions": 123,
    "eventTransactions": 123,
    "scheduleTransactions": 123,
    "sessions": 123,
    "users": 123
  },
  "timeseries": [
    {
      "date": "<string>",
      "total": {
        "transactions": 123,
        "httpTransactions": 123,
        "eventTransactions": 123,
        "scheduleTransactions": 123,
        "sessions": 123,
        "users": 123
      },
      "apps": [
        {
          "slug": "<string>",
          "total": {
            "custom": {}
          },
          "appInstances": [
            {
              "slug": "<string>",
              "total": {
                "custom": {}
              }
            }
          ]
        }
      ]
    }
  ],
  "apps": [
    {
      "slug": "<string>",
      "total": {
        "custom": {}
      },
      "appInstances": [
        {
          "slug": "<string>",
          "total": {
            "custom": {}
          }
        }
      ]
    }
  ]
}

Authorizations

​
X-Prismeai-API-Key
string
header
required
​
connect.sid
string
cookie
required

Path Parameters

​
workspaceId
string
required

ID of workspace to listen to

Query Parameters

​
afterDate
string
required

Retrieve usage stats after this ISO8601 formatted date.

​
beforeDate
string
required

Retrieve usage stats before this ISO8601 formatted date.

​
interval
enum<string>

If specified, this field will add a field to the result containing the usage over time at the specified interval. The queried data will be found in the timeseries field.

Available options:
month,
day
​
details
boolean

Includes individual appInstances details

Response

200
application/json
Success Response
​
workspaceId
string
required
​
beforeDate
string
required
​
afterDate
string
required
​
total
object
required
​
apps
object[]
required
​
interval
string
​
timeseries
object[]

Was this page helpful?

Raise issue