> ## Documentation Index > Fetch the complete documentation index at: https://docs.promptingcompany.com/llms.txt > Use this file to discover all available pages before exploring further. # Ingest server-side SDK analytics event (page_visit) ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/analytics/events openapi: 3.1.0 info: title: The Prompting Company API version: 0.1.0 description: >- Machine-readable contract for The Prompting Company organization-scoped API routes. contact: name: The Prompting Company url: https://promptingcompany.com/support email: support@promptingcompany.com license: name: Proprietary url: https://promptingcompany.com/terms termsOfService: https://promptingcompany.com/terms servers: - url: https://app.promptingco.com description: Production - url: http://localhost:3000 description: Local development security: [] tags: - name: Visibility & Mentions - name: Knowledge - name: Content - name: Simulations - name: Apps & Publishing paths: /api/v1/analytics/events: post: tags: - Visibility & Mentions summary: Ingest server-side SDK analytics event (page_visit) operationId: postAnalyticsEvents requestBody: required: true content: application/json: schema: type: object properties: event: type: string enum: - page_visit occurredAt: type: string format: date-time eventId: type: string minLength: 1 sessionId: type: - string - 'null' anonymousId: type: - string - 'null' page: type: object properties: href: type: string format: uri domain: type: string pathname: type: string title: type: - string - 'null' canonicalUrl: type: - string - 'null' format: uri required: - href request: type: object properties: referrer: type: - string - 'null' userAgent: type: - string - 'null' clientIp: type: - string - 'null' method: type: - string - 'null' sdk: type: object properties: name: type: string version: type: string runtime: type: string properties: type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - event - page responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean enum: - true data: type: object properties: ok: type: boolean enum: - true data: type: object properties: accepted: type: boolean enum: - true eventId: type: string status: type: string enum: - accepted receivedAt: type: string format: date-time required: - accepted - eventId - status - receivedAt required: - ok - data required: - ok - data '400': description: Bad request content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '401': description: Authentication required content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '403': description: Forbidden content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '404': description: Not found content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '422': description: Validation failed content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '500': description: Internal server error content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message security: - apiKeyAuth: [] - bearerAuth: [] - cookieAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: >- Organization-scoped API key. Available scopes: - content:read: Read site pages, markdown content, and llms.txt files - content:write: Create, update, and delete site pages and content - prompts:read: Read prompts, topics, and prompt analysis results - prompts:write: Create, update, archive prompts - simulations:read: Read agent-simulation tasks, runs, environments, and analytics - simulations:write: Create and trigger simulation runs - logs:read: Read AI-traffic logs and request-level audit events - analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) - products:read: Read product metadata and competitor data - products:write: Update product settings and competitor lists x-scopes: content:read: Read site pages, markdown content, and llms.txt files content:write: Create, update, and delete site pages and content prompts:read: Read prompts, topics, and prompt analysis results prompts:write: Create, update, archive prompts simulations:read: Read agent-simulation tasks, runs, environments, and analytics simulations:write: Create and trigger simulation runs logs:read: Read AI-traffic logs and request-level audit events analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) products:read: Read product metadata and competitor data products:write: Update product settings and competitor lists bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Bearer session or OAuth access token. Available OAuth scopes: - content:read: Read site pages, markdown content, and llms.txt files - content:write: Create, update, and delete site pages and content - prompts:read: Read prompts, topics, and prompt analysis results - prompts:write: Create, update, archive prompts - simulations:read: Read agent-simulation tasks, runs, environments, and analytics - simulations:write: Create and trigger simulation runs - logs:read: Read AI-traffic logs and request-level audit events - analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) - products:read: Read product metadata and competitor data - products:write: Update product settings and competitor lists x-scopes: content:read: Read site pages, markdown content, and llms.txt files content:write: Create, update, and delete site pages and content prompts:read: Read prompts, topics, and prompt analysis results prompts:write: Create, update, archive prompts simulations:read: Read agent-simulation tasks, runs, environments, and analytics simulations:write: Create and trigger simulation runs logs:read: Read AI-traffic logs and request-level audit events analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) products:read: Read product metadata and competitor data products:write: Update product settings and competitor lists cookieAuth: type: apiKey in: cookie name: better-auth.session_token description: First-party browser session cookie. ````