Lucidya

Lucidya Ltd Analytics Pages API

Endpoints for discovering and managing analytics pages, widgets, and filters

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /analytics/pages List analytics pages available to my company · Get Analytics Pages #
Ask an LLM
“Which analytics pages does my company have access to?”
“Is the in-chat survey page among the analytics pages I can query?”
Tell an agent
List all analytics pages available to my company.
Show me the analytics page names I can build jobs for.
GET /analytics/{page_name}/widgets List widgets available on an analytics page · Get Page Widgets #
Ask an LLM
“What widgets can I request on the agents analytics page?”
“How do I find valid widget names before creating an analytics job?”
Tell an agent
List the widgets available on analytics page {page_name}.
Show widget names I can request for the {page_name} page.
GET /analytics/{page_name}/filters Get filter definitions for an analytics page · Get Page Filters #
Ask an LLM
“Which filters can I apply on the SLAs analytics page?”
“What filter options does a given analytics page support?”
Tell an agent
Get the filter definitions for analytics page {page_name}.
Show what filters are supported on the {page_name} page.

Documentation

📖
Documentation
https://docs.lucidya.com/docs/Social-Listening-api/rqwky70duwx76-get-started
📖
APIReference
https://docs.lucidya.com/docs/Social-Listening-api/wainb9dny9w1y-lucidya-social-listening-public-api
📖
GettingStarted
https://docs.lucidya.com/docs/Social-Listening-api/rqwky70duwx76-get-started
📖
Authentication
https://docs.lucidya.com/docs/Social-Listening-api/uh64vtmx7x4kl-authorization
📖
Documentation
https://docs.lucidya.com/docs/ai-api/l9nsga0nmis4v-get-started
📖
APIReference
https://docs.lucidya.com/docs/ai-api/zl9th61r4qjdz-lucidya-public-ai-api
📖
GettingStarted
https://docs.lucidya.com/docs/ai-api/l9nsga0nmis4v-get-started
📖
Authentication
https://docs.lucidya.com/docs/ai-api/sjq8uo8o8lt93-authorization
📖
Documentation
https://docs.lucidya.com/docs/cdp-api/lnrpbrm3b9yp9-get-started
📖
APIReference
https://docs.lucidya.com/docs/cdp-api/ns8sfqyr1dgw6-cdp-customer-data-platform-api
📖
GettingStarted
https://docs.lucidya.com/docs/cdp-api/lnrpbrm3b9yp9-get-started
📖
Authentication
https://docs.lucidya.com/docs/cdp-api/6tqmgs82r4jxa-authorization
📖
Documentation
https://docs.lucidya.com/docs/omnichannel-api/q1nc0ntpokxgs-get-started
📖
APIReference
https://docs.lucidya.com/docs/omnichannel-api/d1ow4caem6i5x-omni-channel-api
📖
GettingStarted
https://docs.lucidya.com/docs/omnichannel-api/q1nc0ntpokxgs-get-started
📖
Authentication
https://docs.lucidya.com/docs/omnichannel-api/cfqqlsohea8mv-authorization
📖
Documentation
https://docs.lucidya.com/docs/omniserve/jjdvsz08tba5c-get-started
📖
APIReference
https://docs.lucidya.com/docs/omniserve/mjhuba7fdw882-omni-serve-analytics-api
📖
GettingStarted
https://docs.lucidya.com/docs/omniserve/jjdvsz08tba5c-get-started
📖
Authentication
https://docs.lucidya.com/docs/omniserve/8s65uy0al6adj-authorization

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lucidya-ltd/refs/heads/main/openapi/lucidya-ltd-analytics-pages-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lucidya-ltd:lucidya-ltd-analytics-pages-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lucidya-ltd-analytics-pages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: OmniServe Analytics Analytics Pages API
  description: 'Complete API collection for Lucidya OmniServe Analytics Endpoints. This API provides access to

    analytics data for engagement monitoring, CSAT surveys, and reporting capabilities.


    Features include:

    - Analytics pages and widgets discovery

    - Job-based analytics data retrieval

    - CSAT survey analytics

    - Reference data access (agents, teams, data sources)'
  contact:
    name: API Support
    email: support@lucidya.com
    url: https://lucidya.com
  license:
    url: https://opensource.org/licenses/MIT
    name: MIT
servers:
- url: https://api.lucidya.com/public_api/omniserve
  description: Production Server
security:
- OmniserveToken: []
tags:
- name: Analytics Pages
  description: Endpoints for discovering and managing analytics pages, widgets, and filters
paths:
  /analytics/pages:
    get:
      tags:
      - Analytics Pages
      summary: Get Analytics Pages
      description: 'This endpoint enables you to get the list of all analytics pages available to your company.


        **Note:** Returns pages like inbox, slas, agents, and in-chat-survey.'
      operationId: getAnalyticsPages
      responses:
        '200':
          description: Pages list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: inbox
              examples:
                default:
                  value:
                    data:
                    - id: 1
                      name: inbox
                    - id: 2
                      name: slas
                    - id: 3
                      name: agents
                    - id: 4
                      name: in-chat-survey
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/{page_name}/widgets:
    get:
      tags:
      - Analytics Pages
      summary: Get Page Widgets
      description: This endpoint enables you to list available widgets for a specific analytics page.
      operationId: getPageWidgets
      parameters:
      - name: page_name
        in: path
        description: Analytics page identifier (e.g., inbox, slas, agents)
        required: true
        schema:
          type: string
          example: inbox
      responses:
        '200':
          description: Widgets metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  widgets_names:
                    type: array
                    items:
                      type: string
                    example:
                    - Inbox Overview
                    - Engagements Volume
                  company_time_zone:
                    type: integer
                    example: 3
                  page_name:
                    type: string
                    example: inbox
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
  /analytics/{page_name}/filters:
    get:
      tags:
      - Analytics Pages
      summary: Get Page Filters
      description: This endpoint enables you to get filter definitions for a specific analytics page.
      operationId: getPageFilters
      parameters:
      - name: page_name
        in: path
        description: Analytics page identifier
        required: true
        schema:
          type: string
          example: inbox
      responses:
        '200':
          description: Filters list
          content:
            application/json:
              schema:
                type: object
                properties:
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        filter_key:
                          type: string
                          example: data_sources
                        filter_label:
                          type: string
                          example: Data Sources
                        values:
                          type: array
                          items:
                            type: object
                            properties:
                              label:
                                type: string
                                example: twitter
                              value:
                                type: integer
                                example: 1
                  page_name:
                    type: string
                    example: inbox
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
      - OmniserveToken: []
      servers:
      - url: https://api.lucidya.com/public_api/omniserve
        description: Production Server
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 400
            detail:
              type: string
              example: Page_id is required
        status:
          type: integer
          example: 400
        message:
          type: string
          example: Error message
        code:
          type: string
          example: ERROR_CODE
  responses:
    ValidationFailed:
      description: Unprocessable Entity - validation failed or missing required fields
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 422
                message: Validation failed
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 500
                message: Internal server error
    NotAcceptable:
      description: Not Acceptable - the requested format is not supported
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 406
                message: Not acceptable
    Unauthorized:
      description: Unauthorized - invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 401
                message: Authentication required
    Gone:
      description: Gone - the requested resource is no longer available
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 410
                message: Resource gone
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 403
                message: Access denied
    NotFound:
      description: Not Found - the specified resource could not be found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 404
                message: Resource not found
    BadRequest:
      description: Bad request - invalid input or validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 400
                detail: Page_id is required
    MethodNotAllowed:
      description: Method Not Allowed - HTTP method is not supported for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 405
                message: Method not allowed
    ServiceUnavailable:
      description: Service Unavailable - temporary server overload or maintenance
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 503
                message: Service unavailable
    RateLimited:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 429
                message: Rate limit exceeded
                retry_after: 60
    GatewayTimeout:
      description: Gateway Timeout - server took too long to respond
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            default:
              value:
                status: 504
                message: Gateway timeout
  securitySchemes:
    OmniserveToken:
      type: apiKey
      description: The API authorization token for the request
      name: luc-authorization
      in: header
      x-example: YOUR_API_TOKEN_HERE