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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Admiral Analytics API
version: 0.1.0
tags:
- name: Analytics
paths:
/analytics/signup:
post:
tags:
- Analytics
summary: Signup Completed
operationId: signup_completed_analytics_signup_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignupBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/analytics/heard:
post:
tags:
- Analytics
summary: Heard About
description: 'The answer to "How did you hear about Admiral?" (row 2.5, 7 Oct 2026).
Asked once, optionally, on the first screen after sign up rather than on
the sign-up card: sign up is the step that limits customers, and a box
there is one more thing between a visitor and an account
(desks/engineering/output/2026-10-07-launch-rows/heard-about-placement).
The first answer is kept on the person''s signup_succeeded row, beside
the click ids the same row already carries, so one row says both what
the person says brought them and what the click says did. It goes to
PostHog as its own event, once.'
operationId: heard_about_analytics_heard_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HeardBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/analytics/identity:
get:
tags:
- Analytics
summary: Identity Flags
description: 'Whether the signed-in person is one of us, for PostHog''s internal flag,
and which workspace they are in, for its organization group.
The browser asks at every sign-in, not only at sign-up: the sign-up
handoff runs once, in the first day, so it would never reach the people
who already had accounts. The operator list stays on the server; the
browser learns one boolean about the person already signed in.
The workspace is the one `get_or_create_org` would pick (most recently
joined), read without creating one: a lookup that makes a workspace
would count a person who never finished signing up as a customer.'
operationId: identity_flags_analytics_identity_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
components:
schemas:
HeardBody:
properties:
answer:
type: string
maxLength: 200
minLength: 1
title: Answer
type: object
required:
- answer
title: HeardBody
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
SignupBody:
properties:
provider:
type: string
maxLength: 40
title: Provider
default: unknown
click:
additionalProperties:
type: string
type: object
title: Click
type: object
title: SignupBody
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError