Introduction
API reference
Every call an organisation’s key can make, answered as JSON: 36 of them, each with its fields, its answer and its errors.
Example request
curl "https://console.brevily.com/api/NORTHWIND/links?limit=10" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET"Example answer
HTTP/1.1 401 Unauthorized{ "code": "UNAUTHENTICATED", "message": "invalid credential", "requestId": "18188559082372202519"}HTTP/1.1 401 Unauthorized{ "code": "UNAUTHENTICATED", "message": "signature nonce already used within the accepted window", "details": { "reason": "NONCE_REUSED" }, "requestId": "18188559082372202519"}Made-up values.
IntroductionPermalink
- AuthenticationA key’s ID and secret as two headers, or a signed request instead.
- The base addressEvery call sits under /api and your organisation’s code.
- Lists and pagingLists answer a page at a time; the headers say where you are.
- ErrorsA refusal answers its status and a body with a plain code.
- Retrying safelyAn Idempotency-Key header makes a retry do nothing twice.
- Rate limitsCalls are counted a minute and a day at a time.
The callsPermalink
- Links13 calls: List the organisation’s links, Create a link, Switch several links on or off, Move several links to the trash, Get a link, Change a link, Move a link to the trash, Get a link’s QR code style, Set a link’s QR code style, Reset a link’s QR code to the plain code, Get a link’s QR code as PNG, Get a link’s QR code as SVG, Restore a link from the trash
- Analytics4 calls: Get clicks per day, Get the traffic figures, List a link’s clicks, Get a link’s click figures
- Events6 calls: List events, Report events in bulk, Report an event, Open a link in its app, Report an event against a link, Report an event against a click
- Domains2 calls: List domains, Get a domain
- Folders2 calls: List the organisation’s folders, Get a folder
- Tags2 calls: List the organisation’s tags, Get a tag
- Integrations6 calls: List the integrations, Add an integration, Delete an integration, List integration deliveries, Roll a webhook’s signing secret, Send a test event to an integration
- Your key1 call: Get the person behind the key
Type a call, a field or a guide.