insights

Create insight record

Create insight record with given parameters

post/create/insight

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/create/insight
  • Auth
    none declared

Request body

insight_namestring required

Name of the insight. Type: string.

insight_typestring required

Type of the insight (e.g., LLM, keyword). Type: string.

indicator_score_typestring required

Score type for the indicator. Type: string.

insight_descriptionstring

Description of the insight. Type: string.

insight_helpstring

Help text for the insight. Type: string.

group_listinteger[] required

List of group IDs associated with the insight (Available for). Type: array of integer.

insight_guidelinestring

Guidelines for the insight (for LLM type). Type: string.

insight_outputstring

Output for the insight (for LLM type). Type: string.

insight_examplestring

Example for the insight (for LLM type). Type: string.

hit_outcome_bystring

Hit outcome by (for keyword type). Type: string.

miss_outcome_bystring

Miss outcome by (for keyword type). Type: string.

hit_keywordsstring

Hit keywords (comma-separated, for keyword type). Type: string.

miss_keywordsstring

Miss keywords (comma-separated, for keyword type). Type: string.

hit_mentionstring

Hit mention (for keyword type). Type: string.

miss_mentionstring

Miss mention (for keyword type). Type: string.

Response

The result of the submission and insight_id for the newly added insight.

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring required

Error message when result='error'. String. Empty/null on success.

datastring

Response payload. Shape varies by endpoint.

Changes

No recorded changes to this operation across all 2 revisions of this API.