Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

Error

A valid request URL is required to generate request examples

[
  {
    "date": "2024-06-01",
    "points": [
      {
        "pipeline": "FAQ",
        "count": 0
      },
      {
        "pipeline": "Documentation",
        "count": 0
      }
    ]
  },
  {
    "date": "2024-06-02",
    "points": []
  }
]

Get requests consumption details

Returns the requests consumption, grouped by query-pipeline, for the given parameters. This endpoint accepts the following combinations of parameters:

If no parameters provided, the current contract period is calculated, then data is returned based on that period.
If startDate and endDate are provided, then the data is returned based on that date range.
If licenseId and periodIndex are provided, then the data is returned based on that specific period data.
Other combination of parameters result in an error.

GET

entitlements

requests

detailed

Error

A valid request URL is required to generate request examples

[
  {
    "date": "2024-06-01",
    "points": [
      {
        "pipeline": "FAQ",
        "count": 0
      },
      {
        "pipeline": "Documentation",
        "count": 0
      }
    ]
  },
  {
    "date": "2024-06-02",
    "points": []
  }
]

Query Parameters

startDate

string

default:""

The results start date, formatted as yyyy-MM-dd.

endDate

string

default:""

The results end date, formatted as yyyy-MM-dd.

licenseId

string

default:""

The entitlements license ID. Use /apps-manager/entitlements/periods to get license IDs.

periodIndex

string

default:""

The entitlement period index in the license. Use /apps-manager/entitlements/periods to get period indices.

Response

200 - application/json

date

string

points

object[]

Show child attributes

Example:

[
  {
    "date": "2024-06-01",
    "points": [
      { "pipeline": "FAQ", "count": 0 },
      { "pipeline": "Documentation", "count": 0 }
    ]
  },
  { "date": "2024-06-02", "points": [] }
]

Get requests consumption summary Get accumulated requests consumption