summary

Programme summary

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.

get/summary

Request

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

Query parameters

range'30d' | '90d' | '12m' | 'all'

30d, 90d, 12m or all. Defaults to 90d.

Response

Programme summary

range'30d' | '90d' | '12m' | 'all' required
sincestring nullable required
untilstring required

Changes

No recorded changes to this operation across all 1 revision of this API.