> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Meer API: Meerapi Get Usage Stats

> Read your Meer API request counts: total, by month and by country. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Read your Meer API request counts: total, by month and by country.

> [!NOTE]
>
> Tool ID: `meerapi_get_usage_stats`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'meerapi_get_usage_stats',
  {},
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute meerapi_get_usage_stats --input '{}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "customer_name": "Example",
    "total_requests": 123,
    "monthly": [
      {
        "year": 123,
        "month": 12,
        "request_count": 123
      }
    ],
    "by_country": [
      {
        "country": "US",
        "request_count": 123
      }
    ]
  }
}
```

Use `deepline describe meerapi_get_usage_stats --json` for the latest machine-readable contract.

## Input reference

Lifetime request counts for your account, by calendar month and country. Free.

This action requires no input fields.

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Lifetime request counts for your account, by calendar month and country. Free.",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.customer_name` | `string` | Yes | — | The account the API key belongs to. |
| `result.data.total_requests` | `integer` | Yes | — | Sum of `monthly[].request_count`. Format: `int64`. |
| `result.data.monthly` | `array` | Yes | — | Oldest month first. Months with no requests may be missing. |
| `result.data.monthly[].year` | `integer` | Yes | — | UTC year. |
| `result.data.monthly[].month` | `integer` | Yes | — | UTC month. Minimum: 1. Maximum: 12. |
| `result.data.monthly[].request_count` | `integer` | Yes | — | Billable requests that month. |
| `result.data.by_country` | `array` | Yes | — | Most requests first, then by country code. |
| `result.data.by_country[].country` | `string` | Yes | — | ISO 3166-1 alpha-2 code. |
| `result.data.by_country[].request_count` | `integer` | Yes | — | Format: `int64`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "customer_name": {
            "type": "string",
            "description": "The account the API key belongs to."
          },
          "total_requests": {
            "type": "integer",
            "description": "Sum of `monthly[].request_count`.",
            "format": "int64"
          },
          "monthly": {
            "type": "array",
            "description": "Oldest month first. Months with no requests may be missing.",
            "items": {
              "type": "object",
              "properties": {
                "year": {
                  "type": "integer",
                  "description": "UTC year."
                },
                "month": {
                  "type": "integer",
                  "description": "UTC month.",
                  "minimum": 1,
                  "maximum": 12
                },
                "request_count": {
                  "type": "integer",
                  "description": "Billable requests that month."
                }
              },
              "required": [
                "year",
                "month",
                "request_count"
              ],
              "additionalProperties": false
            }
          },
          "by_country": {
            "type": "array",
            "description": "Most requests first, then by country code.",
            "items": {
              "type": "object",
              "properties": {
                "country": {
                  "type": "string",
                  "description": "ISO 3166-1 alpha-2 code."
                },
                "request_count": {
                  "type": "integer",
                  "format": "int64"
                }
              },
              "required": [
                "country",
                "request_count"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "customer_name",
          "total_requests",
          "monthly",
          "by_country"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Meer API provider guide](https://deepline.com/docs/providers/meerapi/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.