> ## Documentation Index > Fetch the complete documentation index at: https://octolens.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Mention volume over time > Counts mentions per bucket (day or hour) across the filter window, sorted chronologically. ## OpenAPI ````yaml https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/volume openapi: 3.1.0 info: title: Octolens API version: 2.0.0 description: >- The Octolens API lets you query mentions, manage keywords, and configure feeds programmatically. Every action available in the Octolens UI is available here. ### Authentication All v2 endpoints require an API key. Create one in **Settings > API** and pass it as `Authorization: Bearer `. Keys are scoped to the organization they were minted in; you cannot access another org's data. API keys carry a scope — `read`, `write` (implies read), or `admin` (implies write). Each endpoint documents the scope it needs via the `x-required-scope` OpenAPI extension and the scope badge in the docs surface. ### Rate limiting The v2 API is rate-limited at **500 requests per hour per organization**, across all keys for that org. The limit resets at the top of each hour (sliding hourly window). Every 2xx response carries three headers so clients can pace themselves: * `X-RateLimit-Limit` — the hourly cap (500) * `X-RateLimit-Remaining` — requests left in the current window * `X-RateLimit-Reset` — Unix timestamp (seconds) when the window resets When the cap is hit, the endpoint returns **429 Rate Limited** with an additional `Retry-After` header (seconds until the next window). The response body is the standard `ErrorResponse` with `code: "RATE_LIMITED"`. ### Error handling All non-2xx responses share the same `ErrorResponse` envelope: `{ error: { code, message, status, details? } }`. The `code` field is a stable `ApiErrorCode` enum — branch on it programmatically instead of parsing `message`. See the `ApiErrorCode` schema for the full catalog grouped by category. `VALIDATION_ERROR` (400) responses include a `details` array with per-field Zod issues — inspect `details[i].path` to pinpoint which input was rejected. ### Building filter bodies Endpoints that accept `simpleFilters` / `advancedFilters` (e.g. `POST /api/v2/mentions`, `PATCH /api/v2/feeds/{id}`) take a structured object that can be tricky to hand-craft. If you just have a natural-language description of what you want ("negative posts about pricing on reddit in the last week"), call `POST /api/v2/ai/filter-wizard` with that prompt and it will return a ready-to-use filter object you can pass straight through. servers: - url: https://app.octolens.com description: Production - url: http://localhost:3000 description: Local development security: - ApiKey: [] paths: /api/v2/analytics/volume: get: tags: - Analytics summary: Mention volume over time description: >- Counts mentions per bucket (day or hour) across the filter window, sorted chronologically. operationId: getAnalyticsVolume parameters: - in: query name: keywordIds schema: description: Limit aggregation to specific keyword IDs. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: array items: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Limit aggregation to specific keyword IDs. - in: query name: platforms schema: description: Filter to specific platforms. anyOf: - $ref: '#/components/schemas/Platform' - type: array items: $ref: '#/components/schemas/Platform' description: Filter to specific platforms. - in: query name: tag schema: $ref: '#/components/schemas/MentionTag' description: >- Narrow to mentions carrying this AI-assigned tag. See `MentionTag` for all values. description: >- Narrow to mentions carrying this AI-assigned tag. See `MentionTag` for all values. - in: query name: sentiment schema: type: string enum: - POSITIVE - NEUTRAL - NEGATIVE - in: query name: relevance schema: description: >- Relevance scores to include. 0 = high relevance, 1 = medium, 2 = low. Default: [0, 1]. anyOf: - type: integer minimum: 0 maximum: 2 - type: array items: type: integer minimum: 0 maximum: 2 description: >- Relevance scores to include. 0 = high relevance, 1 = medium, 2 = low. Default: [0, 1]. - in: query name: startDate schema: description: >- Inclusive start of the window. ISO 8601 datetime. If omitted together with endDate, defaults to the last 30 days. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Inclusive start of the window. ISO 8601 datetime. If omitted together with endDate, defaults to the last 30 days. - in: query name: endDate schema: description: >- Exclusive end of the window. ISO 8601 datetime. If omitted together with startDate, defaults to "now". type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Exclusive end of the window. ISO 8601 datetime. If omitted together with startDate, defaults to "now". - in: query name: granularity schema: description: Bucket size. Default `day`. default: day type: string enum: - day - hour description: Bucket size. Default `day`. responses: '200': description: 200 response content: application/json: schema: $ref: '#/components/schemas/VolumeResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden (insufficient plan or permissions) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: Platform: description: Platform a mention can originate from / a keyword can be monitored on. example: reddit type: string enum: - dev - github - hackernews - linkedin - producthunt - reddit - stackoverflow - twitter - youtube - tiktok - medium - reddit_comment - bluesky - newsletter - podcasts - news - firehose MentionTag: description: >- AI-assigned topic tag. Applied by the relevance worker during scoring. A post can carry multiple tags. example: competitor_mention type: string enum: - buy_intent - competitor_mention - customer_testimonial - promotional_post - own_brand_mention - industry_insights - hiring - event - product_question - pricing - churn_intent - launch_announcement - bug_report - user_feedback - ai_generated VolumeResponse: type: object properties: granularity: description: Granularity that was used (echoes the request). type: string enum: - day - hour data: description: >- Sorted chronologically, ascending. Empty buckets are omitted (not zero-filled). type: array items: $ref: '#/components/schemas/VolumeEntry' required: - granularity - data additionalProperties: false ErrorResponse: description: >- Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. type: object properties: error: type: object properties: code: $ref: '#/components/schemas/ApiErrorCode' description: >- Machine-readable error code. See `ApiErrorCode` for the full list. example: NOT_FOUND message: description: Human-readable error message. example: Resource not found type: string status: description: HTTP status code — always matches the response status. example: 404 type: integer minimum: -9007199254740991 maximum: 9007199254740991 details: description: >- Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message). type: array items: {} required: - code - message - status additionalProperties: false required: - error additionalProperties: false VolumeEntry: type: object properties: bucket: description: >- Bucket start. `YYYY-MM-DD` for daily granularity, ISO datetime (`YYYY-MM-DDTHH:00:00Z`) for hourly. example: '2026-04-22' type: string count: description: Number of mentions that fell in this bucket. type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - bucket - count additionalProperties: false ApiErrorCode: description: >- Stable, machine-readable error code. Grouped as follows: **Auth / request shape** — `UNAUTHORIZED` (401), `FORBIDDEN` (403), `RATE_LIMITED` (429), `VALIDATION_ERROR` (400 — response carries a `details` array with Zod issues), `INTERNAL_ERROR` (500). **Not found (404)** — generic `NOT_FOUND` plus domain-specific variants: `FEED_NOT_FOUND`, `KEYWORD_NOT_FOUND`, `POST_NOT_FOUND`, `SUMMARY_NOT_FOUND`, `SUGGESTION_NOT_FOUND`, `COMPANY_NOT_FOUND`, `ORG_NOT_FOUND`, `SETTINGS_NOT_FOUND`. **Business-rule violations (400)** — `KEYWORD_LIMIT_EXCEEDED` (plan cap hit), `LAST_ADMIN` (refuses to remove the only admin), `ITEM_EXISTS` (duplicate), `INVALID_DOMAIN`, `INVALID_TIMEZONE`. type: string enum: - UNAUTHORIZED - FORBIDDEN - RATE_LIMITED - VALIDATION_ERROR - INTERNAL_ERROR - NOT_FOUND - FEED_NOT_FOUND - KEYWORD_NOT_FOUND - POST_NOT_FOUND - SUMMARY_NOT_FOUND - SUGGESTION_NOT_FOUND - COMPANY_NOT_FOUND - ORG_NOT_FOUND - SETTINGS_NOT_FOUND - KEYWORD_LIMIT_EXCEEDED - LAST_ADMIN - ITEM_EXISTS - INVALID_DOMAIN - INVALID_TIMEZONE securitySchemes: ApiKey: type: http scheme: bearer description: >- Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer `. ````