← Back to schema index

GetUsageHistoryAttributes

Attributes of the resource returned when querying the user's monthly usage history (period, validations used, and applicable cap).

Properties

FieldTypeDescription
dataobjectResponse body. Everything hangs off here, per the JSON:API envelope.
typestringResource type, fixed for this operation. Part of the resource identity in the JSON:API envelope.
attributesobjectThe resource's own data, kept apart from its identity.
monthsintegerHow many months the returned history covers.
historyarrayOne entry per month, oldest first.

Used in operations

  • GET /v1/usage/history