# Clarity Overview API

**Canonical:** https://apis.io/apis/onclarity-com/onclarity-com-overview-api/  
**Provider:** Clarity — https://apis.io/providers/onclarity-com/  
**Base URL:** https://api.onclarity.com  
**Documentation:** https://api.onclarity.com

Clarity Overview API is one of 101 APIs that [Clarity](https://apis.io/providers/onclarity-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include overview. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The overview API from Clarity — 10 operation(s) for overview.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/insights` | Get Insights |
| POST | `/api/v1/group-bys-list` | List Group Bys |
| POST | `/api/v1/trend` | Get Search Trend |
| POST | `/api/v1/distribution` | Get Search Distribution |
| GET | `/api/v1/search-suggestions` | List Search Suggestions |
| GET | `/api/v1/prompt-suggestions` | List Prompt Suggestions |
| GET | `/api/v1/custom-prompts` | List Custom Prompts |
| POST | `/api/v1/custom-prompts` | Add Custom Prompt |
| GET | `/api/v1/custom-prompts/{custom_prompt_id}` | Get Custom Prompt |
| DELETE | `/api/v1/custom-prompts/{custom_prompt_id}` | Delete Custom Prompt |
| POST | `/api/v1/profile` | Get Profile Info |
| GET | `/api/v1/insight-blocks` | Get Insight Blocks |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-overview-api-openapi.yml
- **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

## Other Clarity APIs (12)

- [Clarity Accounts API](https://apis.io/apis/onclarity-com/onclarity-com-accounts-api/)
- [Clarity Admin API](https://apis.io/apis/onclarity-com/onclarity-com-admin-api/)
- [Clarity Agent Costs API](https://apis.io/apis/onclarity-com/onclarity-com-agent-costs-api/)
- [Clarity Agent Qa API](https://apis.io/apis/onclarity-com/onclarity-com-agent-qa-api/)
- [Clarity Agent Store Admin API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-admin-api/)
- [Clarity Agent Store API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-api/)
- [Clarity Agent Usage API](https://apis.io/apis/onclarity-com/onclarity-com-agent-usage-api/)
- [Clarity Anecdote Surveys API](https://apis.io/apis/onclarity-com/onclarity-com-anecdote-surveys-api/)
- [Clarity Anomalies API](https://apis.io/apis/onclarity-com/onclarity-com-anomalies-api/)
- [Clarity Asana API](https://apis.io/apis/onclarity-com/onclarity-com-asana-api/)
- [Clarity Bugs API](https://apis.io/apis/onclarity-com/onclarity-com-bugs-api/)
- [Clarity Classifications Admin API](https://apis.io/apis/onclarity-com/onclarity-com-classifications-admin-api/)

## Tags

overview

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/onclarity-com/onclarity-com-overview-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/onclarity-com/.