analytics

Get analytics

Retrieve aggregated Guard request analytics bucketed by time and project.

The response groups buckets by project. Each bucket covers one resolution interval and contains request and detection counts for that interval.

Authentication. Use a Platform API key from the AI Guardrails Dashboard — not the Guard API key used for inference requests at api.lakera.ai.

Timestamps. Both start_time and end_time must be UTC (use the Z or +00:00 suffix). Sub-minute seconds are silently floored to the nearest minute. After flooring, start_time must remain strictly before end_time.

Resolution. An ISO 8601 duration string: PT{n}M, PT{n}H, or P{n}D where n is a positive integer (e.g. PT15M, PT6H, P7D). The time range after flooring must divide evenly by the resolution. The maximum range is 180 days.

Access. This endpoint is available to select organizations. Contact your Check Point representative to request access. Community users may also reach out to support@lakera.ai.

post/v1-beta/analytics

Request

  • Base URL: https://platform.lakera.ai/api
  • URL: https://platform.lakera.ai/api/v1-beta/analytics
  • Auth: HTTP bearer

Request body

start_timestring date-time required

Start of the time range (inclusive). Must be a UTC timestamp — use the Z or +00:00 suffix. Sub-minute seconds are silently floored.

end_timestring date-time required

End of the time range (exclusive). Must be a UTC timestamp. After flooring, must be strictly after start_time. The range may not exceed 180 days.

project_idsstring[]

Filter to specific projects. Omit or pass an empty array to return analytics across all projects in your organization.

resolutionstring

Bucket size as an ISO 8601 duration: PT{n}M, PT{n}H, or P{n}D where n is a positive integer (e.g. PT15M, PT6H, P7D). The time range after flooring must divide evenly by the resolution.

Response

Aggregated analytics bucketed by time and project

effective_start_timestring date-time required

The start of the time range after flooring sub-minute seconds, in UTC.

effective_end_timestring date-time required

The end of the time range after flooring sub-minute seconds, in UTC.

resolutionstring required

The bucket size used for this response, echoed from the request.

Changes

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