Skip to content
EntitlerDocs

GET/v1/indexes/{index_key}/values

List an index's values

Lists the monthly changes recorded for indexKey, newest month first, with when each was recorded and applied. Pages through pageSize (24 by default, at most 120) and pageToken. Needs customers:read.

curl 'https://api.entitler.co/v1/indexes/<index_key>/values' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
index_keyrequiredstring

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring
page_sizeinteger (int64)
page_tokenstring

Responses

200The ListIndexValuesResponse message.

ListIndexValuesResponse

  • nextPageTokenstring
  • valuesarray of IndexValuerequired
    • appliedAtinteger

      at least 0; at most 18446744073709552000

    • changeThousandthsinteger (int32)required
    • indexKeystringrequired
    • monthstringrequired
    • recordedAtintegerrequired

      at least 0; at most 18446744073709552000

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired