docs.fusial

Run an analytics report

GET
/analytics/{report}

Authorization

apiKey
x-api-key<token>

Your workspace API key. Create and manage keys in your Fusial workspace settings. Keys carry scopes of the form resource:action.

In: header

Path Parameters

report*string

Which report to run.

Query Parameters

range?string

Date range window. Defaults to 90d when omitted or invalid.

format?string

Set to csv to receive a CSV download instead of JSON.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/overview"
{
  "report": "overview",
  "range": "90d",
  "stats": [
    {
      "key": "created",
      "label": "Contracts created",
      "value": "42",
      "rawValue": 42
    },
    {
      "key": "signed",
      "label": "Contracts signed",
      "value": "31",
      "rawValue": 31
    }
  ]
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}