Clarity Overview API
The overview API from Clarity — 10 operation(s) for overview.
The overview API from Clarity — 10 operation(s) for overview.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-overview-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Overview API
version: 0.1.0
tags:
- name: Overview
paths:
/api/v1/insights:
post:
tags:
- Overview
summary: Get Insights
operationId: get_insights_api_v1_insights_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InsightsRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/group-bys-list:
post:
tags:
- Overview
summary: List Group Bys
operationId: list_group_bys_api_v1_group_bys_list_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupBysListRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/trend:
post:
tags:
- Overview
summary: Get Search Trend
operationId: get_search_trend_api_v1_trend_post
security:
- HTTPBearer: []
parameters:
- name: trend_on
in: query
required: false
schema:
type: string
default: volume
title: Trend On
- name: trend_by
in: query
required: false
schema:
type: string
default: '-'
title: Trend By
- name: segment_field_name
in: query
required: false
schema:
type: string
default: company__filter
title: Segment Field Name
- name: percent_field_name
in: query
required: false
schema:
type: string
default: tags
title: Percent Field Name
- name: percent_field_value
in: query
required: false
schema:
default: bug
title: Percent Field Value
- 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/src__routers__overview__TrendRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/distribution:
post:
tags:
- Overview
summary: Get Search Distribution
operationId: get_search_distribution_api_v1_distribution_post
security:
- HTTPBearer: []
parameters:
- name: distribution_of
in: query
required: false
schema:
type: string
default: volume
title: Distribution Of
- name: distribution_by
in: query
required: false
schema:
type: string
default: '-'
title: Distribution By
- name: stacked_by
in: query
required: false
schema:
type: string
default: '-'
title: Stacked By
- name: percent_field_name
in: query
required: false
schema:
type: string
default: tags
title: Percent Field Name
- name: percent_field_value
in: query
required: false
schema:
anyOf:
- {}
- type: 'null'
title: Percent Field Value
- 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/DistributionRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/search-suggestions:
get:
tags:
- Overview
summary: List Search Suggestions
operationId: list_search_suggestions_api_v1_search_suggestions_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
/api/v1/prompt-suggestions:
get:
tags:
- Overview
summary: List Prompt Suggestions
description: 'Suggested research prompts for the copilot Overview composer.
Mirrors ``GET /search-suggestions`` (sample recent feedback -> small model),
but yields full research questions instead of short search queries. Cached
per project so the chips don''t re-trigger the model on every page load.
Returns:
``{"data": {"suggested_prompts": [...]}}`` - an empty list when the
project has no feedback to sample yet, never an error.'
operationId: list_prompt_suggestions_api_v1_prompt_suggestions_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
/api/v1/custom-prompts:
get:
tags:
- Overview
summary: List Custom Prompts
operationId: list_custom_prompts_api_v1_custom_prompts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
post:
tags:
- Overview
summary: Add Custom Prompt
operationId: add_custom_prompt_api_v1_custom_prompts_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/src__routers__overview__AddCustomPromptRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/custom-prompts/{custom_prompt_id}:
get:
tags:
- Overview
summary: Get Custom Prompt
operationId: get_custom_prompt_api_v1_custom_prompts__custom_prompt_id__get
security:
- HTTPBearer: []
parameters:
- name: custom_prompt_id
in: path
required: true
schema:
type: integer
title: Custom Prompt Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Overview
summary: Delete Custom Prompt
operationId: delete_custom_prompt_api_v1_custom_prompts__custom_prompt_id__delete
security:
- HTTPBearer: []
parameters:
- name: custom_prompt_id
in: path
required: true
schema:
type: integer
title: Custom Prompt Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/profile:
post:
tags:
- Overview
summary: Get Profile Info
operationId: get_profile_info_api_v1_profile_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/insight-blocks:
get:
tags:
- Overview
summary: Get Insight Blocks
operationId: get_insight_blocks_api_v1_insight_blocks_get
security:
- HTTPBearer: []
parameters:
- name: model_name
in: query
required: false
schema:
type: string
default: gpt-5-mini
title: Model Name
- name: x-request-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Request-Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ProfileRequest:
properties:
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
type: object
required:
- filters
title: ProfileRequest
GroupBysListRequest:
properties:
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
type: object
required:
- filters
title: GroupBysListRequest
DistributionRequest:
properties:
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
default: message_text
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
type: object
required:
- filters
title: DistributionRequest
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__overview__AddCustomPromptRequest:
properties:
prompt_begin:
type: string
title: Prompt Begin
prompt_end:
type: string
title: Prompt End
filters:
items:
additionalProperties: true
type: object
type: array
title: Filters
default:
- key: survey_ids
type: exists
operator: neq
title:
type: string
title: Title
description:
type: string
title: Description
is_default:
type: boolean
title: Is Default
default: false
type: object
required:
- prompt_begin
- prompt_end
- title
- description
title: AddCustomPromptRequest
InsightsRequest:
properties:
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
type: object
required:
- filters
title: InsightsRequest
src__routers__overview__TrendRequest:
properties:
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
default: message_text
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
type: object
required:
- filters
title: TrendRequest
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