Skip to main content
GET
/
organisations
/
{orgId}
/
workspaces
/
{workspaceId}
/
metrics
List metrics
curl --request GET \
  --url https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "7b9e5d2c-f314-48a9-be56-9843a2f6c019",
      "title": "Daily Active Users",
      "ownerId": "user_123456789",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "description": "Number of unique users who performed any action in the last 24 hours",
      "unit": "users",
      "type": "custom",
      "targetOperator": "greater_than",
      "targetValue": 100,
      "targetDirection": "up",
      "currentValue": 150,
      "previousValue": 140,
      "periodType": "calendar",
      "periodValue": "month",
      "timeseries": [
        {
          "date": "2023-11-07T05:31:56Z",
          "value": 85
        }
      ],
      "relatedOutcomes": [
        "<unknown>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT authentication for organization-scoped endpoints.

Path Parameters

orgId
string
required

Organization ID

workspaceId
string
required

Workspace ID

Query Parameters

outcomeId
string

Optional outcome ID to filter metrics by. If omitted, returns all metrics for the workspace.

Response

Success

Response containing an array of metrics

data
object[]
required

Array of metrics