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.
openapi: 3.2.0
info:
title: asobeast Alerts API
description: 'Self hosted ASO toolkit API.
A metered instance carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset on every response, for the tightest limit the request touched. A self hosted instance has no request rate limits and sends no such header. Limits are per workspace, so minting more tokens does not buy more capacity, and they are sized per plan across three classes: read for stored data, write for configuration changes and store for the endpoints that reach the App Store or Google Play.
A 429 carries Retry-After and a rateLimit object naming the window that closed, or an aiAllowance object when the workspace has spent the AI calls its plan includes this month. A 403 with a quota object means a plan capacity limit such as apps or tracked keyword markets, which is a different problem from a rate limit. A 402 with an entitlement object means the workspace needs a plan.
Positions are 1-based and null means checked but not found within the captured depth, never zero. Daily granularity uses UTC dates.'
version: 1.15.0
contact: {}
servers:
- url: http://localhost:3000/api/backend
description: Web origin proxy
- url: http://localhost:4000
description: Direct API
security:
- personalApiToken: []
tags:
- name: Alerts
paths:
/alerts/config:
get:
operationId: AlertsController_config
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
summary: Probe which alert channels are available
tags:
- Alerts
/alerts/delivery:
get:
operationId: AlertsController_delivery
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
summary: Report the alert delivery mode and outbox status
tags:
- Alerts
/alerts/flush:
post:
operationId: AlertsController_flushNow
parameters: []
responses:
'201':
description: ''
content:
application/json:
schema:
type: object
summary: Flush the alert outbox into grouped deliveries
tags:
- Alerts
/alerts/deliveries:
get:
operationId: AlertsController_listDeliveries
parameters:
- name: webhookId
required: false
in: query
schema:
type: string
- name: emailAlertId
required: false
in: query
schema:
type: string
- name: limit
required: true
in: query
schema:
minimum: 1
maximum: 200
default: 50
allOf:
- $ref: '#/components/schemas/Object'
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
summary: List recent alert deliveries for one channel
tags:
- Alerts
components:
schemas:
Object:
type: object
properties: {}
securitySchemes:
personalApiToken:
scheme: bearer
bearerFormat: asob
type: http