Clarity

Clarity Surveys API

The surveys API from Clarity — 7 operation(s) for surveys.

GitHub OpenAPI

Operations 7

GET /api/v1/surveys List Surveys #
GET /api/v1/surveys/{survey_id} Get Survey Info #
POST /api/v1/surveys/{survey_id}/responses Get Survey Responses #
GET /api/v1/surveys/{survey_id}/responses/{response_id} Get Survey Response By Id #
POST /api/v1/surveys/{survey_id}/qualitative/{question_key} Get Qualitative Taxonomy #
POST /api/v1/surveys/{survey_id}/nps/{question_key} Get Nps Question Data #
POST /api/v1/surveys/{survey_id}/barchart/{question_key} Get Barchart Question Data #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-surveys-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-dashboard-element-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-build-table-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-deeper-search-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-agent-response-schema.json

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/onclarity-com:onclarity-com-surveys-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

onclarity-com-surveys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Surveys API
  version: 0.1.0
tags:
- name: Surveys
paths:
  /api/v1/surveys:
    get:
      tags:
      - Surveys
      summary: List Surveys
      operationId: list_surveys_api_v1_surveys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/surveys/{survey_id}:
    get:
      tags:
      - Surveys
      summary: Get Survey Info
      operationId: get_survey_info_api_v1_surveys__survey_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/surveys/{survey_id}/responses:
    post:
      tags:
      - Surveys
      summary: Get Survey Responses
      operationId: get_survey_responses_api_v1_surveys__survey_id__responses_post
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/src__routers__surveys__SurveyResponsesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SurveyResponses'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/surveys/{survey_id}/responses/{response_id}:
    get:
      tags:
      - Surveys
      summary: Get Survey Response By Id
      operationId: get_survey_response_by_id_api_v1_surveys__survey_id__responses__response_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      - name: response_id
        in: path
        required: true
        schema:
          type: string
          title: Response Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Survey Response By Id Api V1 Surveys  Survey Id  Responses  Response Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/surveys/{survey_id}/qualitative/{question_key}:
    post:
      tags:
      - Surveys
      summary: Get Qualitative Taxonomy
      operationId: get_qualitative_taxonomy_api_v1_surveys__survey_id__qualitative__question_key__post
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      - name: question_key
        in: path
        required: true
        schema:
          type: string
          title: Question Key
      - name: x-request-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Request-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualitativeTaxonomyRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/surveys/{survey_id}/nps/{question_key}:
    post:
      tags:
      - Surveys
      summary: Get Nps Question Data
      operationId: get_nps_question_data_api_v1_surveys__survey_id__nps__question_key__post
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      - name: question_key
        in: path
        required: true
        schema:
          type: string
          title: Question Key
      - name: granularity
        in: query
        required: false
        schema:
          type: string
          default: day
          title: Granularity
      - name: x-request-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Request-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualitativeTaxonomyRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/surveys/{survey_id}/barchart/{question_key}:
    post:
      tags:
      - Surveys
      summary: Get Barchart Question Data
      operationId: get_barchart_question_data_api_v1_surveys__survey_id__barchart__question_key__post
      security:
      - HTTPBearer: []
      parameters:
      - name: survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Survey Id
      - name: question_key
        in: path
        required: true
        schema:
          type: string
          title: Question Key
      - name: x-request-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Request-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualitativeTaxonomyRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    src__routers__surveys__SurveyResponsesRequest:
      properties:
        filters:
          items:
            $ref: '#/components/schemas/QueryFilter'
          type: array
          title: Filters
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          type: integer
          title: Limit
      type: object
      required:
      - filters
      - limit
      title: SurveyResponsesRequest
    SurveyResponses:
      properties:
        table:
          items:
            anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          type: array
          title: Table
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          type: integer
          title: Limit
          default: 10
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
      - table
      - total_pages
      title: SurveyResponses
    QualitativeTaxonomyRequest:
      properties:
        filters:
          items:
            $ref: '#/components/schemas/QueryFilter'
          type: array
          title: Filters
      type: object
      required:
      - filters
      title: QualitativeTaxonomyRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    QueryFilter:
      properties:
        type:
          anyOf:
          - type: string
            const: exists
          - type: string
            const: list
          - type: string
            const: nested
          - type: string
            const: range
          - type: string
            const: text
          title: Type
        key:
          type: string
          title: Key
        values:
          anyOf:
          - items:
              type: string
            type: array
          - items:
              type: integer
            type: array
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: string
          - type: 'null'
          title: Values
        min:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Min
        max:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Max
        operator:
          anyOf:
          - type: string
            const: eq
          - type: string
            const: neq
          - type: string
            const: contains
          title: Operator
          default: eq
        generated:
          type: boolean
          title: Generated
          default: false
      type: object
      required:
      - type
      - key
      title: QueryFilter
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic