> ## Documentation Index > Fetch the complete documentation index at: https://docs.getreply.in/llms.txt > Use this file to discover all available pages before exploring further. # Usage report > What you sent, spent and called through the API, by hour, day, week or month (India time). Messages are those sent with an API key that reached WhatsApp or failed: read, delivered, sent (accepted by WhatsApp, no delivery report yet) and failed. Spent is what each message was charged, in rupees; a failed message adds nothing. Messages and spend include campaigns made with the key. Requests and errors count your API calls. A key that is not yours answers validation_error on key: "No key with this id." Permission: Any key (Full, Send only or Read only). ## OpenAPI ````yaml /openapi.json get /v1/usage/report openapi: 3.1.0 info: title: GetReply API version: 1.0.0 description: >- Send WhatsApp messages, templates, OTPs and campaigns from your own software. Every request needs an API key (Developer → API keys) as a Bearer token. Requests sent here are real and charged like any other. servers: - url: https://api.getreply.in description: GetReply security: - bearerAuth: [] tags: - name: Account - name: Messages - name: Templates - name: Contacts - name: Inbox - name: Campaigns - name: Webhooks - name: Request log paths: /v1/usage/report: get: tags: - Account summary: Usage report description: >- What you sent, spent and called through the API, by hour, day, week or month (India time). Messages are those sent with an API key that reached WhatsApp or failed: read, delivered, sent (accepted by WhatsApp, no delivery report yet) and failed. Spent is what each message was charged, in rupees; a failed message adds nothing. Messages and spend include campaigns made with the key. Requests and errors count your API calls. A key that is not yours answers validation_error on key: "No key with this id." Permission: Any key (Full, Send only or Read only). parameters: - name: from in: query required: false description: 'First day, like 2026-11-07 (India time). Default: 6 days before to.' schema: type: string format: date - name: to in: query required: false description: 'Last day, like 2026-11-13 (India time). Default: today.' schema: type: string format: date - name: group_by in: query required: false description: >- hour, day, week or month. Default: day. hour works for one day only. Weeks start on Monday. schema: type: string enum: - hour - day - week - month - name: key in: query required: false description: >- An API key's id. Repeat it to pick more than one. Leave it out for all keys. schema: type: string responses: '200': description: The report. content: application/json: schema: type: object properties: currency: type: string enum: - INR from: type: string format: date to: type: string format: date group_by: type: string enum: - hour - day - week - month keys: type: - array - 'null' items: type: string description: The keys asked for; null = all keys. totals: type: object properties: spent: type: string example: '2166.46' messages: type: integer delivered: type: integer read: type: integer sent: type: integer failed: type: integer requests: type: integer errors: type: integer spent_by_category: type: object properties: marketing: type: string example: '2166.46' utility: type: string example: '2166.46' authentication: type: string example: '2166.46' buckets: type: array items: type: object properties: start: type: string format: date-time end: type: string format: date-time spent: type: string example: '2166.46' spent_by_category: type: object properties: marketing: type: string example: '2166.46' utility: type: string example: '2166.46' authentication: type: string example: '2166.46' messages: type: integer messages_by_category: type: object properties: marketing: type: integer utility: type: integer authentication: type: integer service: type: integer read: type: integer delivered: type: integer sent: type: integer failed: type: integer requests: type: integer errors: type: integer by_key: type: array items: type: object properties: key_id: type: string name: type: string deleted: type: boolean messages: type: integer delivered: type: integer spent: type: string example: '2166.46' requests: type: integer errors: type: integer last_used_at: type: - string - 'null' format: date-time errors: type: array items: type: object properties: code: type: string message: type: string count: type: integer last_seen_at: type: string format: date-time by_country: type: array items: type: object properties: country: type: string example: IN messages: type: integer delivered: type: integer spent: type: string example: '2166.46' by_endpoint: type: array items: type: object properties: method: type: string path: type: string requests: type: integer errors: type: integer average_ms: type: integer example: currency: INR from: string to: string group_by: hour keys: - string totals: spent: '2166.46' messages: 1 delivered: 1 read: 1 sent: 1 failed: 1 requests: 1 errors: 1 spent_by_category: marketing: '2166.46' utility: '2166.46' authentication: '2166.46' buckets: - start: '2026-10-26T11:20:00+05:30' end: '2026-10-26T11:20:00+05:30' spent: '2166.46' spent_by_category: marketing: '2166.46' utility: '2166.46' authentication: '2166.46' messages: 1 messages_by_category: marketing: 1 utility: 1 authentication: 1 service: 1 read: 1 delivered: 1 sent: 1 failed: 1 requests: 1 errors: 1 by_key: - key_id: string name: string deleted: true messages: 1 delivered: 1 spent: '2166.46' requests: 1 errors: 1 last_used_at: '2026-10-26T11:20:00+05:30' errors: - code: string message: string count: 1 last_seen_at: '2026-10-26T11:20:00+05:30' by_country: - country: IN messages: 1 delivered: 1 spent: '2166.46' by_endpoint: - method: string path: string requests: 1 errors: 1 average_ms: 1 '400': description: 'validation_error: Some fields are missing or wrong.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: validation_error: value: error: code: validation_error message: Some fields are missing or wrong. field: key reason: No key with this id. '401': description: 'unauthorized: API key is missing or not valid.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized: value: error: code: unauthorized message: API key is missing or not valid. '403': description: >- key_off: This API key is switched off. · forbidden_scope: This API key isn't allowed to do this. · ip_not_allowed: Requests from this IP address aren't allowed for this key. · needs_pro_plan: The API needs the Pro plan. · plan_ended: Your plan has ended. Renew it to send messages. content: application/json: schema: $ref: '#/components/schemas/Error' examples: key_off: value: error: code: key_off message: This API key is switched off. forbidden_scope: value: error: code: forbidden_scope message: This API key isn't allowed to do this. ip_not_allowed: value: error: code: ip_not_allowed message: >- Requests from this IP address aren't allowed for this key. needs_pro_plan: value: error: code: needs_pro_plan message: The API needs the Pro plan. plan_ended: value: error: code: plan_ended message: Your plan has ended. Renew it to send messages. '429': description: 'rate_limited: Too many requests. Try again in a few seconds.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: rate_limited: value: error: code: rate_limited message: Too many requests. Try again in a few seconds. '500': description: 'server_error: Something went wrong on our side. Try again.' content: application/json: schema: $ref: '#/components/schemas/Error' examples: server_error: value: error: code: server_error message: Something went wrong on our side. Try again. components: schemas: Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string message: type: string field: type: string description: >- The one field that is wrong, when there is one: its path in your request, 0-based for lists, e.g. buttons[0].phone, header.text, audience.numbers[12].to. example: buttons[0].phone reason: type: string description: >- validation_error only: what is wrong with that field, in plain words, when we have words for that check. Left out otherwise. example: Add a valid phone number. status_code: type: - integer - 'null' description: >- webhook_test_failed only: the status code your link answered; null when it gave none. securitySchemes: bearerAuth: type: http scheme: bearer description: Your API key, e.g. gr_live_… ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.