Get v2workspaces usage

Retrieve workspace usage stats

GET /v2/workspaces/{workspaceId}/usage

cURL

cURL

curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "workspaceId": "<string>",
  "beforeDate": "<string>",
  "afterDate": "<string>",
  "total": {
    "transactions": 123,
    "httpTransactions": 123,
    "eventTransactions": 123,
    "scheduleTransactions": 123,
    "sessions": 123,
    "users": 123
  },
  "apps": [
    {
      "slug": "<string>",
      "total": {
        "custom": {}
      },
      "appInstances": [
        {
          "slug": "<string>",
          "total": {
            "custom": {}
          }
        }
      ]
    }
  ],
  "interval": "<string>",
  "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": {}
              }
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Show child attributes

apps · object[] · required

Show child attributes

interval · string

timeseries · object[]

Show child attributes