Ask

Plain-language questions answered with real data.

Generated

This page is generated from api/openapi/v1.yaml (OpenAPI 3.1.0, API version 1.0.0).

Ask a question in plain language

POST/v1/properties/{pid}/ask

Scope: ask. Eureka's analyst (Claude) picks the right reports, runs them on your data and answers with figures that all come from tool results, plus a chart suggestion and the report spec it used. Counts toward the plan's monthly AI questions.

Parameters

Name	In	Type	Required	Description
pid	path	string	yes	Property id.

Request body

Field	Type	Required	Description
question	string	yes

{
  "question": "Where do agents drop off in checkout compared with humans?"
}

Responses

Status	Description
200	Answer.
400	Invalid body or query (invalid_request), with errors[] for validation failures.
401	Missing, invalid, expired or revoked API key (unauthorized).
402	The plan does not include the feature (plan_required) or a monthly quota is used up (quota_exceeded). required_plan is the cheapest plan that unlocks it.
403	The key lacks the required scope (forbidden_scope).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).
503	The feature is not available on this installation (internal, status 503).

Response fields

Field	Type	Required	Description
question	string
title	string
answer	string		Narrative answer; every figure comes from a query result.
chart	string | null		Suggested visualization: kpi, line, bar, stacked_bar, table, pie, funnel, sunburst, sankey…
kind	string | null
report_spec	object | null
result	any		Data of the chosen result.
calls	array of object
model	string
quota	object