Fallax Summary API
The summary API from Fallax — 1 operation(s) for summary.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/fallax-io:fallax-io-summary-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Fallax Io Summary API
version: v1
description: 'Operations tagged summary across 2 of this provider''s published API definitions: fallax-io-openapi.json, fallax-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.fallax.io/v1
tags:
- name: Summary
paths:
/summary:
get:
operationId: getSummary
summary: Programme summary
description: '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.'
tags:
- Summary
security:
- bearerAuth: []
x-scope: read
parameters:
- schema:
type: string
description: '`30d`, `90d`, `12m` or `all`. Defaults to `90d`.'
enum:
- 30d
- 90d
- 12m
- all
required: false
description: '`30d`, `90d`, `12m` or `all`. Defaults to `90d`.'
name: range
in: query
responses:
'200':
description: Programme summary
content:
application/json:
schema:
$ref: '#/components/schemas/Summary'
'400':
description: A parameter or body field the API cannot use. The message names the field.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: No key, an unknown key, or one that has been revoked.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: A read-only key was used on a write endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: '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.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: The path exists but not with that verb. `Allow` lists the verbs that work.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Our fault. Safe to retry.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.fallax.io/v1
components:
schemas:
Summary:
type: object
properties:
range:
type: string
enum:
- 30d
- 90d
- 12m
- all
since:
type:
- string
- 'null'
until:
type: string
totals:
type: object
properties:
targeted:
type: integer
sent:
type: integer
opened:
type: integer
clicked:
type: integer
submitted:
type: integer
replied:
type: integer
reported:
type: integer
campaigns:
type: integer
recipients:
type: integer
learningViewed:
type: integer
learningCompleted:
type: integer
required:
- targeted
- sent
- opened
- clicked
- submitted
- replied
- reported
- campaigns
- recipients
- learningViewed
- learningCompleted
rates:
type: object
properties:
openRate:
type: number
clickRate:
type: number
submitRate:
type: number
replyRate:
type: number
reportRate:
type: number
coverage:
type: number
learningCompletionRate:
type: number
required:
- openRate
- clickRate
- submitRate
- replyRate
- reportRate
- coverage
- learningCompletionRate
previous:
type:
- object
- 'null'
properties:
campaigns:
type: integer
sent:
type: integer
clickRate:
type: number
submitRate:
type: number
replyRate:
type: number
reportRate:
type: number
coverage:
type: number
required:
- campaigns
- sent
- clickRate
- submitRate
- replyRate
- reportRate
- coverage
required:
- range
- since
- until
- totals
- rates
- previous
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unauthorized
- forbidden
- not_found
- invalid_request
- method_not_allowed
- rate_limited
- internal
message:
type: string
required:
- code
- message
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: flx_
description: A workspace API key, created in Settings.
x-refined-from:
- fallax-io-openapi.json
- fallax-io-openapi.json