---
title: "Programme summary"
method: GET
path: "/summary"
tags: ["summary"]
---

# Programme summary

`GET /summary`

## Request

- Base URL: `https://api.fallax.io/v1`
- URL: `https://api.fallax.io/v1/summary`
- Auth: HTTP bearer

Headline numbers for a period: people tested, messages delivered, and the open, click, credential-submit and report rates, each with the previous period of the same length beside it.

## Query parameters

- `range` '30d' | '90d' | '12m' | 'all': `30d`, `90d`, `12m` or `all`. Defaults to `90d`.

## Response `200`

Programme summary

- Summary
  - `range` '30d' | '90d' | '12m' | 'all', required
  - `since` string, nullable, required
  - `until` string, required
  - `totals` object, required
    - `targeted` integer, required
    - `sent` integer, required
    - `opened` integer, required
    - `clicked` integer, required
    - `submitted` integer, required
    - `reported` integer, required
    - `campaigns` integer, required
    - `recipients` integer, required
    - `learningViewed` integer, required
    - `learningCompleted` integer, required
  - `rates` object, required
    - `openRate` number, required
    - `clickRate` number, required
    - `submitRate` number, required
    - `reportRate` number, required
    - `coverage` number, required
    - `learningCompletionRate` number, required
  - `previous` object, nullable, required
    - `campaigns` integer, required
    - `sent` integer, required
    - `clickRate` number, required
    - `submitRate` number, required
    - `reportRate` number, required
    - `coverage` number, required

## Other responses

- `400`: A parameter or body field the API cannot use. The message names the field.
- `401`: No key, an unknown key, or one that has been revoked.
- `403`: A read-only key was used on a write endpoint.
- `404`: No such endpoint, or no such row in this workspace. The two are deliberately indistinguishable from outside: another workspace's ids must not be probeable.
- `405`: The path exists but not with that verb. `Allow` lists the verbs that work.
- `429`: More than 120 requests in a minute on one key. `Retry-After` says how long to wait. A poll every minute, and the paging behind it, is nowhere near this.
- `500`: Our fault. Safe to retry.

---

[API](https://skmtc.dev/fallax/apis/fallax-api.md) · [All operations](https://skmtc.dev/fallax/apis/fallax-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fallax/apis/fallax-api/revisions/b5731fd85ef8?raw)