Clarity Discovery API
The discovery API from Clarity — 10 operation(s) for discovery.
Operations 10
POST
/api/v1/discovery/bullet-points/sentiment-distribution
Get Bullet Points Sentiment Distribution
#
The discovery API from Clarity — 10 operation(s) for discovery.
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-discovery-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 Discovery API
version: 0.1.0
tags:
- name: Discovery
paths:
/api/v1/discovery:
post:
tags:
- Discovery
summary: Get Taxonomy
operationId: get_taxonomy_api_v1_discovery_post
security:
- HTTPBearer: []
parameters:
- 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/AllTaxonomyNodesRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/tickets:
post:
tags:
- Discovery
summary: List Taxonomy Tickets
operationId: list_taxonomy_tickets_api_v1_discovery_tickets_post
security:
- HTTPBearer: []
parameters:
- 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/TaxonomyTicketsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/trends:
post:
tags:
- Discovery
summary: List Taxonomy Trends
operationId: list_taxonomy_trends_api_v1_discovery_trends_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: 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/TaxonomyTrendsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/bubble:
post:
tags:
- Discovery
summary: Get Bubble
operationId: get_bubble_api_v1_discovery_bubble_post
security:
- HTTPBearer: []
parameters:
- name: bubble_field_name
in: query
required: false
schema:
type: string
default: anecdote_ids
title: Bubble Field Name
- name: bubble_field_value
in: query
required: false
schema:
default: account > access
title: Bubble 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/TaxonomyTrendsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/distributions:
post:
tags:
- Discovery
summary: List Taxonomy Distributions
operationId: list_taxonomy_distributions_api_v1_discovery_distributions_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:
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/TaxonomyDistributionsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/summary:
post:
tags:
- Discovery
summary: Get Summary
description: 'To test this function use cURL instead of Postman, because Postman doesn''t support streaming responses.
curl -X POST --no-buffer --header "Content-Type: application/json" --header "X-Customer-Name: bank-al-etihad" --header "Authorization: Bearer ..." -d ''{"filters": []}'' http://localhost:3005/api/v1/discovery/summary'
operationId: get_summary_api_v1_discovery_summary_post
security:
- HTTPBearer: []
parameters:
- 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/TaxonomySummaryRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/bullet-points:
post:
tags:
- Discovery
summary: List Bullet Points
operationId: list_bullet_points_api_v1_discovery_bullet_points_post
security:
- HTTPBearer: []
parameters:
- 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/BulletPointsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/bullet-points/sentiment-distribution:
post:
tags:
- Discovery
summary: Get Bullet Points Sentiment Distribution
operationId: get_bullet_points_sentiment_distribution_api_v1_discovery_bullet_points_sentiment_distribution_post
security:
- HTTPBearer: []
parameters:
- 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/BulletPointsSentimentDistributionRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/promoters-detractors:
post:
tags:
- Discovery
summary: List Promoters Detractors
operationId: list_promoters_detractors_api_v1_discovery_promoters_detractors_post
security:
- HTTPBearer: []
parameters:
- 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/PromotersDetractorsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/discovery/chat:
post:
tags:
- Discovery
summary: Get Chat Response
description: 'To test this function use cURL instead of Postman, because Postman doesn''t support streaming responses.
curl -X POST --no-buffer --header "Content-Type: application/json" --header "X-Customer-Name: bank-al-etihad" --header "Authorization: Bearer ..." -d ''{"filters": [], "history": [{"role": "user", "content": "what are the main issues?"}]}'' http://localhost:3005/api/v1/discovery/chat'
operationId: get_chat_response_api_v1_discovery_chat_post
security:
- HTTPBearer: []
parameters:
- 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/ChatRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TaxonomyTrendsRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
default: []
trend_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
type: object
title: TaxonomyTrendsRequest
TaxonomySummaryRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
question:
anyOf:
- type: string
- type: 'null'
title: Question
custom_prompt_begin:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt Begin
custom_prompt_end:
anyOf:
- type: string
- type: 'null'
title: Custom Prompt End
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
additional_fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Additional Fields
default: []
force_refresh:
type: boolean
title: Force Refresh
default: false
use_external_urls:
anyOf:
- type: boolean
- type: 'null'
title: Use External Urls
default: false
type: object
required:
- filters
title: TaxonomySummaryRequest
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
BulletPointsRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
question:
anyOf:
- type: string
- type: 'null'
title: Question
calculate_sentiment_distribution:
type: boolean
title: Calculate Sentiment Distribution
default: false
type: object
required:
- filters
title: BulletPointsRequest
ChatHistoryItem:
properties:
role:
type: string
pattern: ^(assistant|user)$
title: Role
content:
type: string
title: Content
type: object
required:
- role
- content
title: ChatHistoryItem
AllTaxonomyNodesRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
return_max_ds:
type: boolean
title: Return Max Ds
default: false
return_min_ds:
type: boolean
title: Return Min Ds
default: false
return_max_ts:
type: boolean
title: Return Max Ts
default: false
return_min_ts:
type: boolean
title: Return Min Ts
default: false
return_trend:
type: boolean
title: Return Trend
default: false
competition_mode:
type: boolean
title: Competition Mode
default: false
search_query:
anyOf:
- type: string
- type: 'null'
title: Search Query
description: Page-level search query. Limits the taxonomy counts to its results, with the same relevance-thresholded retrieval the /search/* endpoints use.
min_score:
type: number
minimum: 0.0
title: Min Score
description: Relevance floor for `search_query`; 0 keeps everything the filters match.
default: 1.0
type: object
required:
- filters
title: AllTaxonomyNodesRequest
ExtraFilters:
properties:
include_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Include Filters
exclude_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Exclude Filters
size:
type: integer
title: Size
default: 10240
type: object
title: ExtraFilters
PromotersDetractorsRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
question:
anyOf:
- type: string
- type: 'null'
title: Question
type: object
required:
- filters
title: PromotersDetractorsRequest
TaxonomyDistributionsRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
default: []
distribution_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
stacking_filters:
anyOf:
- $ref: '#/components/schemas/ExtraFilters'
- type: 'null'
type: object
title: TaxonomyDistributionsRequest
ChatRequest:
properties:
search_query:
anyOf:
- type: string
- type: 'null'
title: Search Query
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
do_spellcheck:
anyOf:
- type: boolean
- type: 'null'
title: Do Spellcheck
default: true
do_translate:
anyOf:
- type: boolean
- type: 'null'
title: Do Translate
default: true
do_filters_extraction:
anyOf:
- type: boolean
- type: 'null'
title: Do Filters Extraction
default: true
do_intent_analysis:
anyOf:
- type: boolean
- type: 'null'
title: Do Intent Analysis
default: true
main_field:
anyOf:
- type: string
- type: 'null'
title: Main Field
additional_fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Additional Fields
default: []
history:
items:
$ref: '#/components/schemas/ChatHistoryItem'
type: array
title: History
force_refresh:
anyOf:
- type: boolean
- type: 'null'
title: Force Refresh
default: true
type: object
required:
- filters
- history
title: ChatRequest
QuerySort:
properties:
key:
type: string
title: Key
order:
anyOf:
- type: string
const: asc
- type: string
const: desc
title: Order
default: asc
type: object
required:
- key
title: QuerySort
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TaxonomyTicketsRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
limit:
type: integer
title: Limit
default: 100
offset:
type: integer
title: Offset
default: 0
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
default: []
sorted_by:
items:
$ref: '#/components/schemas/QuerySort'
type: array
title: Sorted By
default: []
type: object
title: TaxonomyTicketsRequest
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
BulletPointsSentimentDistributionRequest:
properties:
taxonomy_key:
type: string
title: Taxonomy Key
default: default
anecdote_id:
anyOf:
- type: string
- type: 'null'
title: Anecdote Id
category_id:
anyOf:
- type: string
- type: 'null'
title: Category Id
filters:
items:
$ref: '#/components/schemas/QueryFilter'
type: array
title: Filters
insight_key:
type: string
title: Insight Key
type: object
required:
- filters
- insight_key
title: BulletPointsSentimentDistributionRequest
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic