# info.description
URL shortener and click analytics API.

**Authentication:** all endpoints require a Bearer API key (`Authorization: Bearer ca_...`).
Generate keys from your dashboard at https://clicaven.com/app/api-keys.

**Rate limits:** per plan, sliding window of 1 minute.

| Plan      | Requests / min |
|-----------|----------------|
| Free      | 30             |
| Pro       | 120            |
| Business  | 300            |
| Scale     | 1000           |

Each response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` and
`X-RateLimit-Plan` headers.

**Webhooks:** see `/api/webhooks` (Business+) for `link.clicked` events with HMAC-SHA256 signature.

# paths./api/links.get.summary
Retrieves the collection of Link resources.

# paths./api/links.get.description
Retrieves the collection of Link resources.

# components.schemas.ConstraintViolation.properties.violations.items.properties.message.description
The message associated with the violation

# components.schemas.ConstraintViolation.properties.violations.items.properties.hint.description
An extra hint to understand the violation

# components.schemas.ConstraintViolation.jsonld.allOf[].properties.violations.items.properties.message.description
The message associated with the violation

# components.schemas.ConstraintViolation.jsonld.allOf[].properties.violations.items.properties.hint.description
An extra hint to understand the violation

# components.schemas.Error.properties.title.description
A short, human-readable summary of the problem.

# components.schemas.Error.properties.detail.description
A human-readable explanation specific to this occurrence of the problem.

# components.schemas.Error.properties.instance.description
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

# components.schemas.Error.properties.type.description
A URI reference that identifies the problem type

# components.schemas.Error.jsonld.allOf[].properties.title.description
A short, human-readable summary of the problem.

# components.schemas.Error.jsonld.allOf[].properties.detail.description
A human-readable explanation specific to this occurrence of the problem.

# components.schemas.Error.jsonld.allOf[].properties.instance.description
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

# components.schemas.Error.jsonld.allOf[].properties.type.description
A URI reference that identifies the problem type

# components.securitySchemes.ApiKey.description
API key generated from /app/api-keys. Send as `Authorization: Bearer ca_...`