> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get custom events aggregation numeric counts

> Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window.
> Scope & filters:
> 	•	promptUuid – The prompt to aggregate (required).
>
> Time window & interval:
> 	•	A time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.
> 	•	If an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.
> 	•	Aggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.
>
> Response:
> 	•	Per interval bucket, returns numeric aggregates derived from raw values: count, sum, min, max, average.
> 	•	Includes minValueTimestampMs and maxValueTimestampMs indicating when min/max occurred within the bucket (if available).
> 	•	Bucket timestamps are returned as epoch ms.
>
> Notes:
> 	•	Only numeric prompt types are valid for this endpoint.

```http
POST https://api2.rhombussystems.com/api/report/getCustomEventsNumericCounts
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request object for custom LLM reports.

- `endTimeMs` (integer<int64> | null): The end timestamp (in Unix epoch milliseconds) of the selected interval
- `interval` (string): Report interval for filtering face events One of: `MINUTELY`, `QUARTERHOURLY`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- `promptUuid` (string<RUUID> | null): base 64 (url-safe) uuid string
- `startTimeMs` (integer<int64> | null): The start timestamp (in Unix epoch milliseconds) of the selected interval

## Response 200

OK. Content type: `application/json`

- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `reports` (map<string, array<object> | null> | null): Map of numeric count reports
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/report/getCustomEventsNumericCounts:
    post:
      description: |
        Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window.
        Scope & filters:
        	•	promptUuid – The prompt to aggregate (required).

        Time window & interval:
        	•	A time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.
        	•	If an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.
        	•	Aggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.

        Response:
        	•	Per interval bucket, returns numeric aggregates derived from raw values: count, sum, min, max, average.
        	•	Includes minValueTimestampMs and maxValueTimestampMs indicating when min/max occurred within the bucket (if available).
        	•	Bucket timestamps are returned as epoch ms.

        Notes:
        	•	Only numeric prompt types are valid for this endpoint.
      operationId: getCustomEventsNumericCounts
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Report_GetCustomLLMWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Report_GetCustomLLMNumericWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get custom events aggregation numeric counts
      tags:
        - Report Webservice
components:
  schemas:
    Report_GetCustomLLMWSRequest:
      description: Request object for custom LLM reports.
      properties:
        endTimeMs:
          description: The end timestamp (in Unix epoch milliseconds) of the selected interval
          example: 1640998800000
          format: int64
          nullable: true
          type: integer
        interval:
          $ref: "#/components/schemas/ReportIntervalEnum"
        promptUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        startTimeMs:
          description: The start timestamp (in Unix epoch milliseconds) of the selected interval
          example: 1640995200000
          format: int64
          nullable: true
          type: integer
      type: object
    ReportIntervalEnum:
      description: Report interval for filtering face events
      enum:
        - MINUTELY
        - QUARTERHOURLY
        - HOURLY
        - DAILY
        - WEEKLY
        - MONTHLY
      type: string
    Report_GetCustomLLMNumericWSResponse:
      description: Response object for custom LLM numeric reports.
      properties:
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        reports:
          additionalProperties:
            description: Map of numeric count reports
            items:
              $ref: "#/components/schemas/NumericAggregationValue"
            nullable: true
            type: array
          description: Map of numeric count reports
          nullable: true
          type: object
        warningMsg:
          nullable: true
          type: string
      type: object
    NumericAggregationValue:
      description: Map of numeric count reports
      properties:
        average:
          format: double
          nullable: true
          type: number
        eventCount:
          format: int64
          nullable: true
          type: integer
        localDate:
          nullable: true
          type: string
        max:
          format: double
          nullable: true
          type: number
        maxValueTimestampMs:
          format: int64
          nullable: true
          type: integer
        min:
          format: double
          nullable: true
          type: number
        minValueTimestampMs:
          format: int64
          nullable: true
          type: integer
        sum:
          format: double
          nullable: true
          type: number
        timestampMs:
          format: int64
          nullable: true
          type: integer
        utcDate:
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````
