llm_analytics

CRUD for evaluation report configurations + report run history.

post/api/projects/{project_id}/llm_analytics/evaluation_reports/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/llm_analytics/evaluation_reports/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid required
evaluationstring uuid required

UUID of the evaluation this report config belongs to.

frequency'scheduled' | 'every_n'
  • scheduled - Scheduled
  • every_n - Every N
rrulestring

RFC 5545 recurrence rule string for scheduled reports. Only daily and weekly cadences are supported: use 'FREQ=DAILY' or 'FREQ=WEEKLY;BYDAY=MO,FR'. Required when frequency is 'scheduled'; ignored otherwise.

starts_atstring date-time nullable required

Read-only anchor datetime used to expand scheduled reports. The server sets this automatically when a report is switched to scheduled mode.

timezone_namestring required

Read-only timezone used for scheduled reports. Evaluation reports use UTC.

next_delivery_datestring date-time nullable required
delivery_targetsunknown
max_sample_sizeinteger

Maximum number of evaluation runs included in each report. Defaults to 200.

enabledboolean

Whether report delivery is active. Disabled configs do not fire.

deletedboolean required

Read-only. Report configs are soft-deleted only when their evaluation is deleted. Use enabled=false to stop deliveries.

last_delivered_atstring date-time nullable required
generated_report_countinteger required

Number of reports generated from this evaluation report config.

last_generated_atstring date-time nullable required

When the most recent report was generated, or null if no reports have been generated.

report_prompt_guidancestring

Optional custom instructions appended to the AI report prompt to steer focus, scope, or section choices without modifying the base prompt.

trigger_thresholdinteger nullable

Number of new evaluation results that triggers a report (every_n mode only). Min 100, max 10000. Defaults to 100. Required when frequency is 'every_n'.

cooldown_minutesinteger

Minimum minutes between count-triggered reports to prevent spam (every_n mode only). Min 60, max 1440 (24 hours). Defaults to 60.

daily_run_capinteger

Maximum count-triggered report runs per calendar day (UTC). Min 1, max 24 (one per cooldown window). Defaults to 10.

created_byinteger nullable required
created_atstring date-time required

Response

idstring uuid required
evaluationstring uuid required

UUID of the evaluation this report config belongs to.

frequency'scheduled' | 'every_n'
  • scheduled - Scheduled
  • every_n - Every N
rrulestring

RFC 5545 recurrence rule string for scheduled reports. Only daily and weekly cadences are supported: use 'FREQ=DAILY' or 'FREQ=WEEKLY;BYDAY=MO,FR'. Required when frequency is 'scheduled'; ignored otherwise.

starts_atstring date-time nullable required

Read-only anchor datetime used to expand scheduled reports. The server sets this automatically when a report is switched to scheduled mode.

timezone_namestring required

Read-only timezone used for scheduled reports. Evaluation reports use UTC.

next_delivery_datestring date-time nullable required
delivery_targetsunknown
max_sample_sizeinteger

Maximum number of evaluation runs included in each report. Defaults to 200.

enabledboolean

Whether report delivery is active. Disabled configs do not fire.

deletedboolean required

Read-only. Report configs are soft-deleted only when their evaluation is deleted. Use enabled=false to stop deliveries.

last_delivered_atstring date-time nullable required
generated_report_countinteger required

Number of reports generated from this evaluation report config.

last_generated_atstring date-time nullable required

When the most recent report was generated, or null if no reports have been generated.

report_prompt_guidancestring

Optional custom instructions appended to the AI report prompt to steer focus, scope, or section choices without modifying the base prompt.

trigger_thresholdinteger nullable

Number of new evaluation results that triggers a report (every_n mode only). Min 100, max 10000. Defaults to 100. Required when frequency is 'every_n'.

cooldown_minutesinteger

Minimum minutes between count-triggered reports to prevent spam (every_n mode only). Min 60, max 1440 (24 hours). Defaults to 60.

daily_run_capinteger

Maximum count-triggered report runs per calendar day (UTC). Min 1, max 24 (one per cooldown window). Defaults to 10.

created_byinteger nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.