How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Insight Panel API

The Insight Panel API from Coveo — 14 operation(s) for insight panel.

Documentation Provider Profile APIs.io OpenAPI GitHub

Coveo Insight Panel API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Insight Panel. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 20 operations across 14 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

20 operations 14 paths 41 schemas 2 DELETE9 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
support@coveo.com
Resource Areas
1

Authentication & Security 1

Coveo Insight Panel API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope.

  • oauth2 — OAuth2

Paths & Operations 20

Across 14 paths, the API surfaces 20 operations — 2 DELETE, 9 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Insight Panel 20
GET
/rest/organizations/{organizationId}/insightconfig/v1/configs
List Insight Panel Configurations
insight-panel-configuration-list 5 params → 200
POST
/rest/organizations/{organizationId}/insightconfig/v1/configs
Create an Insight Panel Configuration
insight-panel-configuration-create 1 param body → 201
POST
/rest/organizations/{organizationId}/insightconfig/v1/configs/ids
List Insight Panel Configurations by Ids.
insight-panel-configuration-list-ids 5 params body → 200
GET
/rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}
Get an Insight Panel Configuration
insight-panel-configuration-get 2 params → 200404
PUT
/rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}
Update an Insight Panel Configuration
insight-panel-configuration-update 2 params body → 200404
DELETE
/rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}
Delete an Insight Panel Configuration
insight-panel-configuration-delete 2 params → 204404
GET
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/interface
Get an Insight Panel Interface
insight-panel-interface-get 2 params → 200
POST
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/search
Search for Items
insight-panel-search 2 params body → 200
POST
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/querysuggest
Retrieve Query Suggestions
insight-panel-query-suggest 2 params body → 200
GET
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/quickview
Retrieve Item Quickview
insight-panel-quickview 6 params → 200
GET
/rest/organizations/{organizationId}/insightconfig/v1/configs/projects/get
Get Insight Configurations by Project
getInsightConfigurationsByProject 6 params → 200
POST
/rest/organizations/{organizationId}/insightinterface/v1/interfaces
Create an Insight Panel Interface
create-insight-panel-interface 1 param body → 201
GET
/rest/organizations/{organizationId}/insightinterface/v1/interfaces
Get All Insight Panel Interfaces
get-all-insight-panel-interfaces 4 params → 200
GET
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}
Get an Insight Panel Interface
get-insight-panel-interface 2 params → 200
PUT
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}
Update an Insight Panel Interface
update-insight-panel-interface 2 params body → 200
DELETE
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}
Delete an Insight Panel Interface
delete-insight-panel-interface 2 params → 204
GET
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions
Get Versions for an Insight Panel Interface
get-insight-panel-interface-versions 6 params → 200
GET
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}
Get an Insight Panel Interface Version
get-insight-panel-interface-version 3 params → 200
POST
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore
Restore an Insight Panel Interface Version
restore-insight-panel-interface-version 3 params body → 200
PUT
/rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label
Update an Insight Panel Interface Version Label
update-insight-panel-interface-version-label 3 params body → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are RestQueryResult (29 properties), RestInsightPanelSearchResponse (24 properties), Analytics (16 properties), RestInsightPanelSearchRequest (12 properties). Each schema is shown below with its type and property counts.

RestContentId
object
2 properties
RestInsightPanelInterface
object
6 properties
RestInsightPanelConfigurationCreate
object
4 properties 2 required
RestInsightPanelConfigurationUpdate
object
4 properties 4 required
RestInsightPanelQuerySuggestRequest
object
10 properties
Analytics
objectnull
16 properties
RestListOfInsightPanelConfigurationsWithProjects
object
3 properties
RestInsightPanelConfigurationListIds
object
1 property 1 required
ActionHistory
object
3 properties 2 required
RestInsightPanelConfiguration
object
6 properties
RestHierarchicalFacetResponseValue
object
6 properties
RestDebug
boolean
Whether to force a successful response to include debug information. Notes: Debug information can only appear in responses in the JSON format (see the format p…
RestHighlightResponse
object
2 properties
RestInsightPanelQuerySuggestResponse
object
3 properties
RestConditions
array
RestInsightPanelSearchResponse
object
24 properties
RestInsightPanelConfigurationWithProjects
RestInsightPanelSearchRequest
object
12 properties
ServiceRestFacetRequest
object
2 properties 2 required
RestQueryResult
object
29 properties
InsightPanelResultTemplate
object
Template
7 properties
UserActionsOptions
object
Options to configure a view of the actions taken by the user who submitted the case.
4 properties
InterfaceVersionInfoPage
ChangeInfo
object
4 properties
Tab
object
The list of tabs to display.
2 properties
InterfaceVersionInfo
object
6 properties
TemplateLayout
string
The template layout to use.
Badge
object
The badge to display.
3 properties
ResultActions
object
The available result actions.
5 properties
Detail
object
The metadata details to display.
2 properties
InsightPanelInterface
object
6 properties
Facet
object
The list of facets to display.
3 properties
SettingsSection
object
3 properties
UpdatedChangeInfo
InsightPanelBodyParams
object
5 properties
CreatedChangeInfo
VersionLabelParams
object
1 property
Tags
object
The tags allowed to be displayed.
3 properties
Page
object
2 properties
Condition
object
The conditions a result needs to meet to use the template.
2 properties
TagParam
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-insight-panel-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Insight Panel
← Back to C APIs
API Details
ID
coveo:coveo-insight-panel-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-insight-panel-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-insight-panel-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Coveo Insight Panel API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.