Skip to content
Sapiom Docs
Go To Dashboard

Get analytics summary

Endpoint

Section titled “Endpoint”

GET /v1/analytics/summary

Authentication

Section titled “Authentication”

No authentication required.

Query Parameters

Section titled “Query Parameters”
ParameterTypeDefaultDescription
filter[time_period]string7dTime period for analytics

cURL Example

Section titled “cURL Example”
Terminal window
curl -X GET "https://api.sapiom.ai/v1/analytics/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Section titled “Response”
{
  "data": {
    "type": "analytics-summary",
    "id": "123e4567-e89b-12d3-a456-426614174000-7d",
    "attributes": {
      "timePeriod": "7d",
      "fromDate": "2025-01-15T00:00:00.000Z",
      "toDate": "2025-01-22T00:00:00.000Z",
      "totalTransactions": 48291,
      "totalTransactionsTrend": 8.2,
      "totalSpendUsd": "2847.32",
      "totalSpendTrend": 12.5,
      "totalDenials": 428,
      "totalDenialsTrend": -15.3,
      "totalAgents": 24,
      "agentsWithRules": 19,
      "totalServices": 12,
      "servicesWithRules": 10,
      "hasEnoughData": true
    }
  },
  "meta": {
    "queriedAt": "2025-01-22T10:30:00.000Z"
  }
}

What’s Next?

Section titled “What’s Next?”