FireFlo OMNI

Every report this account can run: Analytics’ built-in reports, and the reports its team saved and shared with everyone. A report someone kept to themselves is never listed — a key has no person behind it. Run one with GET /v1/reports/{report_id}.

Needs the reports:read scope, and Analytics on the account.

Request

curl "https://api.fireflo.au/v1/reports" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/reports",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/reports", {
  headers: { Authorization: `Bearer ${process.env.OMNI_API_KEY}` },
});
console.log(response.status, await response.json());

Response

200 OK — a built-in report’s id is its name (messages.delivery); a saved report’s is a UUID. source is what it counts (see GET /v1/reports/sources). Categories appear only for what the account has: Calls with Voice, Tickets with Tickets, and so on.

{
  "data": [
    {
      "id": "messages.delivery",
      "kind": "built_in",
      "name": "Delivery and read rate by channel",
      "category": "Messaging",
      "description": "Of what was sent, how much reached phones and was read.",
      "source": "messages",
      "chart": "bar"
    },
    {
      "id": "6f0c2a1e-8b1d-4c39-9a52-0d7e5b3c1f44",
      "kind": "saved",
      "name": "Weekly delivery for the board",
      "category": "Messaging",
      "description": "",
      "source": "messages",
      "chart": "line"
    }
  ]
}

Errors

Status	Error code	When
403	`scope_missing`	The key doesn’t have the `reports:read` scope.

Any request can also be refused for its key, its account or its rate; see the overview.