Trigger an insights run

post

https://app.revenium.ai/api/v2/insights/runs

Start an insights analysis run for the authenticated team over a period of up to 90 days. The request returns 202 Accepted right away with the runId and its status. Poll GET /api/v2/insights/runs/{runId} until status is completed, partial or failed. The Location response header holds the polling URL.

Only one run can be in progress for the team at a time. Narrow the analysis with the filter* fields, and skip checks with excludeInvestigatorIds (see GET /api/v2/insights/investigators).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

Hashed id of the team to answer for. Optional. With a user token it may be any team the user belongs to; without it the user's default team answers. An API key always answers for its own team, and naming any other team is refused with 403.

Body Params

periodStart

string | null

required

Start of the period to analyze, ISO 8601 in UTC. The period can be at most 90 days long.

periodEnd

string | null

required

End of the period to analyze, ISO 8601 in UTC. Must be after periodStart.

filterAgent

array of strings

Defaults to []

Analyze only these agents. Defaults to all agents.

filterAgent

filterProductId

array of strings

Defaults to []

Analyze only these product IDs. Defaults to all products.

filterProductId

filterTraceType

array of strings

Defaults to []

Analyze only these trace types. Defaults to all trace types.

filterTraceType

filterConsumingOrgId

array of strings

Defaults to []

Analyze only usage from these customer organization IDs. Defaults to all customers.

filterConsumingOrgId

filterEnvironment

string

Analyze only this environment. Defaults to an empty string, which means all environments.

filterIncludeCodingAssistants

boolean

Defaults to true

Whether to include coding-assistant usage in the analysis. Defaults to true.

filterIncludeCodingAssistantsForCostDetectors

boolean

Defaults to false

Accepted for compatibility and ignored. Which coding-assistant spend the cost checks include follows the team's coding-assistant pricing policy.

filterDepartmentId

string

Analyze only this department. Omit it to analyze all departments.

filterIncludeDescendants

boolean

Defaults to true

When filterDepartmentId is set, whether to include its sub-departments. Defaults to true.

excludeInvestigatorIds

array of strings

IDs of investigators to skip. Get valid IDs from GET /api/v2/insights/investigators. Omit it to run them all.

excludeInvestigatorIds

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

API Key

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

202Trigger an insights run

400Bad Request: the request is invalid. code is one of INVALID_IDEMPOTENCY_KEY, INVALID_INPUT, INVALID_TEAM_ID, VALIDATION_ERROR.

401Unauthorized: the API key or token is missing or invalid. code is UNAUTHORIZED.

403Forbidden: the credential may not make this request. code is one of FORBIDDEN, TEAM_NOT_IN_MEMBERSHIP.

409Conflict: the request conflicts with one already made. code is one of IDEMPOTENCY_KEY_CONFLICT, IDEMPOTENCY_REQUEST_IN_PROGRESS, RUN_IN_PROGRESS.

429Too Many Requests: the rate limit was exceeded. code is RATE_LIMITED.

500Internal Server Error: the request could not be completed. code is one of ANALYSIS_UNAVAILABLE, INTERNAL_ERROR, INTERNAL_SERVER_ERROR, MISSING_CONFIG.

503Service Unavailable: try again later. code is IDEMPOTENCY_BACKEND_UNAVAILABLE.