What is happening across an organisation

Retrieve activity and cost for a window, filterable to one suite or one app.

GET/v1/organizations/{organizationId}/analytics

Request

curl --request GET \
  --url 'https://studio.grid82.app/v1/organizations/<organizationId>/analytics' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://studio.grid82.app/v1/organizations/<organizationId>/analytics"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/organizations/<organizationId>/analytics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/organizations/<organizationId>/analytics");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://studio.grid82.app/v1/organizations/<organizationId>/analytics", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/organizations/<organizationId>/analytics"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/organizations/<organizationId>/analytics")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "window": {
      "days": 123.45,
      "from": "<string>",
      "to": "<string>"
    },
    "totals": {
      "suites": 123.45,
      "apps": 123.45,
      "users": 123.45,
      "builders": 123.45,
      "activeUsers": 123.45,
      "recordsWritten": 123.45,
      "machineCalls": 123.45,
      "signIns": 123.45
    },
    "daily": [
      {
        "day": "<string>",
        "activeUsers": 123.45,
        "records": 123.45,
        "calls": 123.45
      }
    ],
    "byApp": [
      {
        "appId": "<string>",
        "name": "<string>",
        "suiteId": "<string>",
        "activeUsers": 123.45,
        "records": 123.45,
        "calls": 123.45,
        "members": 123.45
      }
    ],
    "bySurface": [
      {
        "via": "<string>",
        "count": 123.45
      }
    ],
    "assistant": {
      "runs": 123.45,
      "proposed": 123.45,
      "applied": 123.45,
      "costUsd": 123.45,
      "tokens": 123.45
    },
    "plan": {
      "id": "free",
      "usage": {
        "suites": 123,
        "apps": 123,
        "users": 123,
        "builders": 123,
        "storageBytes": 123,
        "customDomains": 123
      },
      "limits": {}
    }
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Counts come from the platform’s event log, which records that something happened, never its contents: for example, a row was created in a table, not the row. Answer where work is happening, who is using an app, and what the assistant is costing.

Requires the account:read scope. Operation analytics.get. MCP tool analytics_get. CLI: grid82 analytics get (npx grid82).

Path parameters

Name	Type	Required	Description
`organizationId`	string	yes

Query parameters

Name	Type	Required	Description
`suiteId`	string	no
`appId`	string	no
`days`	integer	no	Default `30`.

Response

application/json

Success

dataobjectrequired

Show child attributes

data.windowobjectrequired

Show child attributes

data.window.daysnumberrequired

data.window.fromstringrequired

data.window.tostringrequired

data.totalsobjectrequired

Show child attributes

data.totals.suitesnumberrequired

data.totals.appsnumberrequired

data.totals.usersnumberrequired

data.totals.buildersnumberrequired

data.totals.activeUsersnumberrequired

data.totals.recordsWrittennumberrequired

data.totals.machineCallsnumberrequired

data.totals.signInsnumberrequired

data.dailyobject[]required

Show child attributes

data.daily.daystringrequired

data.daily.activeUsersnumberrequired

data.daily.recordsnumberrequired

data.daily.callsnumberrequired

data.byAppobject[]required

Show child attributes

data.byApp.appIdstringrequired

data.byApp.namestringrequired

data.byApp.suiteIdstringrequired

data.byApp.activeUsersnumberrequired

data.byApp.recordsnumberrequired

data.byApp.callsnumberrequired

data.byApp.membersnumberrequired

data.bySurfaceobject[]required

Show child attributes

data.bySurface.viastringrequired

data.bySurface.countnumberrequired

data.assistantobjectrequired

Show child attributes

data.assistant.runsnumberrequired

data.assistant.proposednumberrequired

data.assistant.appliednumberrequired

data.assistant.costUsdnumberrequired

data.assistant.tokensnumberrequired

data.planobjectrequired

Show child attributes

data.plan.idenum<string>requiredone of: free, starter, pro, custom

data.plan.usageobjectrequired

Show child attributes

data.plan.usage.suitesintegerrequired

data.plan.usage.appsintegerrequired

data.plan.usage.usersintegerrequired

data.plan.usage.buildersintegerrequired

data.plan.usage.storageBytesinteger

data.plan.usage.customDomainsinteger

data.plan.limitsRecord<string, number,boolean,null>required

{ "data": { "window": { "days": 123.45, "from": "<string>", "to": "<string>" }, "totals": { "suites": 123.45, "apps": 123.45, "users": 123.45, "builders": 123.45, "activeUsers": 123.45, "recordsWritten": 123.45, "machineCalls": 123.45, "signIns": 123.45 }, "daily": [ { "day": "<string>", "activeUsers": 123.45, "records": 123.45, "calls": 123.45 } ], "byApp": [ { "appId": "<string>", "name": "<string>", "suiteId": "<string>", "activeUsers": 123.45, "records": 123.45, "calls": 123.45, "members": 123.45 } ], "bySurface": [ { "via": "<string>", "count": 123.45 } ], "assistant": { "runs": 123.45, "proposed": 123.45, "applied": 123.45, "costUsd": 123.45, "tokens": 123.45 }, "plan": { "id": "free", "usage": { "suites": 123, "apps": 123, "users": 123, "builders": 123, "storageBytes": 123, "customDomains": 123 }, "limits": {} } } }

What is happening across an organisation

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown