API Overview¶

The Adwize REST API lets you send events, manage rules, query alerts, and configure your account programmatically.

Base URL¶

https://api.getadwize.com/api/v1

All endpoints are relative to this base URL. For example, to list events:

GET https://api.getadwize.com/api/v1/events/

Authentication¶

Authenticate every request by including your API key in the X-API-Key header:

X-API-Key: your-api-key-here

Find your API key in Settings > API Keys in the Adwize dashboard. See Authentication for details.

Content Type¶

All request and response bodies use JSON. Set the Content-Type header on requests that include a body:

Content-Type: application/json

Rate Limits¶

Endpoint	Limit
`POST /events`	1,000 requests/minute
`GET /events/collect`	2,000 requests/minute
All other endpoints	Fair use (no explicit limit)

When you exceed a rate limit, the API returns 429 Too Many Requests. Back off and retry after a short delay.

Batch your events

Each POST /events request can contain multiple events in the array body. Batching reduces the number of requests and keeps you well within rate limits.

Error Format¶

All errors return a JSON object with a detail field describing the problem:

{
  "detail": "Invalid or missing API key"
}

HTTP Status Codes¶

Code	Meaning
`200 OK`	Request succeeded
`201 Created`	Resource created successfully
`204 No Content`	Resource deleted successfully
`400 Bad Request`	Invalid request body or parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Domain not in allowed list, or insufficient permissions
`404 Not Found`	Resource does not exist
`422 Unprocessable Entity`	Request body failed validation
`429 Too Many Requests`	Rate limit exceeded

Pagination¶

List endpoints support pagination with two query parameters:

Parameter	Type	Default	Description
`skip`	integer	`0`	Number of records to skip
`limit`	integer	`100`	Maximum records to return (max 1,000)

Example: fetch the second page of 50 results:

GET /api/v1/events/?skip=50&limit=50

Versioning¶

The API version is included in the URL path (/api/v1/). The current version is v1. Breaking changes will be released under a new version prefix.

Available Endpoints¶

Resource	Endpoints	Description
Events	`POST /events`, `GET /events/`, `GET /events/types`, `GET /events/sources`	Ingest and query event data
Rules	`POST /rules/`, `GET /rules/`, `PATCH /rules/{id}`, `DELETE /rules/{id}`	Create and manage monitoring rules
Alerts	`GET /alerts/`, `POST /alerts/{id}/resolve`, `POST /alerts/{id}/acknowledge`	Query and manage alerts
Webhooks	Configured via `PATCH /tenants/me`	Push alerts to external systems