Retrieve analytics configuration

View as Markdown
Retrieve the latest saved configuration for one analytics module of your service, using the same saved configuration source as the dashboard and MCP. Includes customer-configured instructions, definitions, parameter and subparameter settings, possible answers, and scoring logic where configured. Internal runtime prompts, provider credentials and editor details are excluded. This is a read-only endpoint: drafts and updates are not supported. It returns one module without pagination or time filters. The current configuration may differ from the version used to analyze an older conversation. A module with no saved configuration returns 404. The top-level data.status is active or inactive for the whole module, independently of individual parameter statuses. Inactive modules still return their saved configuration. Configuration follows the module structure: business_insights is keyed directly by field name; agent_feedback contains parameters, subparameters and optional criteria; custom_module contains conversation and customer sections; lead_quality contains conversation_potential and customer_potential; conversation_summary contains settings and instruction; conversation_dispositions contains dispositions and instruction; concerns_and_queries contains queries, concerns and optional training_materials; templates contains sms, email and whatsapp settings.

Authentication

AuthorizationBearer
Existing private account API key from Developer Hub. Keep it on your backend.

Query parameters

service_idstringRequired1-255 characters

Required authorized service. Client identity is derived from the API key. Nonempty, at most 255 characters; whitespace-only values and control characters are rejected.

module_nameenumRequired
Analytics module whose latest saved configuration is requested.

Response

Successful response.
dataobject
Latest saved configuration for the requested service and module.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error