---
title: "Get usage index values"
url: "https://real-estate-agency.apim.eu/apis/cost-estimation/versions/26a287d6-a67c-4989-b0bd-79a9db45597a/operations/getUsageIndex"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/cost-estimation/versions/26a287d6-a67c-4989-b0bd-79a9db45597a.md

# Get usage index values

`GET` `/usage-index`

Operation ID: `getUsageIndex`

Typical comparable request volume and cost for the category, based on aggregated internal usage data.

## Query parameters

- `business_unit` (string, required)
- `integration_count` (number, float, required)
- `model_release_date` (string, date, optional)

## Responses

- `200` - Usage index values
- `404` - Record not found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Cost & ROI Estimation
  version: 1.0.0
servers:
  - url: https://api.nexora.example/v1
    description: Production
  - url: https://sandbox.api.nexora.example/v1
    description: Sandbox
paths:
  /usage-index:
    get:
      tags:
        - Usage Index
      summary: Get usage index values
      description: Typical comparable request volume and cost for the category, based
        on aggregated internal usage data.
      operationId: getUsageIndex
      parameters:
        - name: business_unit
          in: query
          required: true
          schema:
            type: string
            example: Customer Success
        - name: integration_count
          in: query
          required: true
          schema:
            type: number
            format: float
            example: 6
        - name: model_release_date
          in: query
          schema:
            type: string
            format: date
            example: 2026-02-01
      responses:
        "200":
          description: Usage index values
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UsageIndexValue"
              example:
                business_unit: Customer Success
                as_of: 2025-01-01
                cost_per_1k_requests_usd:
                  low: 18.4
                  average: 25.5
                  high: 34.6
                range_note: Values apply to a typical mid-complexity deployment without
                  adjustments.
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - apiKey: []
components:
  schemas:
    UsageIndexValue:
      type: object
      properties:
        business_unit:
          type: string
          example: Customer Success
        as_of:
          type: string
          format: date
          example: 2025-01-01
        cost_per_1k_requests_usd:
          type: object
          properties:
            low:
              type: number
              format: float
              example: 18.4
            average:
              type: number
              format: float
              example: 25.5
            high:
              type: number
              format: float
              example: 34.6
        range_note:
          type: string
          example: Values apply to a typical mid-complexity deployment without
            adjustments.
    Error:
      type: object
      description: Uniform error format across all Nexora AI APIs.
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: validation_failed
        message:
          type: string
          example: Too few comparable deployments are available for this business unit.
        details:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: basis.comparables_count
        reason:
          type: string
          example: missing
  responses:
    NotFound:
      description: Record not found
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Nexora AI portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```