Get Organization Usage

GET 
/api/v1/organizations/:organization_id/usage

Get usage for a project

Request

Path Parameters

organization_id anyrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

start_window

object

required

anyOf

MOD1

string

end_window

object

required

anyOf

MOD1

string

plan

object

required

anyOf

Plan

total_users Total Users (integer)

Default value: 1

total_indexes Total Indexes (integer)

Default value: 5

total_indexed_pages Total Indexed Pages (integer)

Default value: 10000

credits Credits (integer)

Default value: 30000

has_payment_method Has Payment Method (boolean)

Default value: false

free Free (boolean)

If is a free plan

Default value: true

allowed_index Allowed Index (boolean)

If is allowed to use indexes

Default value: true

allowed_external_index Allowed External Index (boolean)

If is allowed to use external data sources or sinks in indexes

Default value: false

usage

object

required

anyOf

Usage

Response model; use UsageSubmission for tracking

total_users Total Users (integer)

Default value: 0

total_indexes Total Indexes (integer)

Default value: 0

total_indexed_pages Total Indexed Pages (integer)

Default value: 0

extract_pages Extract Pages (integer)

Default value: 0

parse_pages Parse Pages (integer)

Default value: 0

index_pages Index Pages (integer)

Default value: 0

credits Credits (integer)

Default value: 0

Example (from schema)

{
  "start_window": "2024-07-29T15:51:28.071Z",
  "end_window": "2024-07-29T15:51:28.071Z",
  "plan": {},
  "usage": {}
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}