> ## 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.

# Attention Get Usage Report: Inputs, Cost & CLI Example

> Get Usage Report. Attention Attention Get Usage Report docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=attention_get_usage_report:{"startDate":"{{startDate}}","endDate":"{{endDate}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                 | Type     | Required | Default | Description                                        |
| -------------------- | -------- | -------- | ------- | -------------------------------------------------- |
| `payload.user-uuids` | `array`  | No       |         | List of user UUIDs to include in the report        |
| `payload.team-uuids` | `array`  | No       |         | List of team UUIDs to include in the report        |
| `payload.startDate`  | `string` | Yes      |         | Start date for the usage report period (inclusive) |
| `payload.endDate`    | `string` | Yes      |         | End date for the usage report period (inclusive)   |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves detailed usage statistics for specified users or teams within a given time period. This endpoint helps track API consumption, feature usage, and user activity patterns.",
    "properties": {
      "user-uuids": {
        "type": "array",
        "description": "List of user UUIDs to include in the report",
        "items": {
          "type": "string"
        }
      },
      "team-uuids": {
        "type": "array",
        "description": "List of team UUIDs to include in the report",
        "items": {
          "type": "string"
        }
      },
      "startDate": {
        "type": "string",
        "description": "Start date for the usage report period (inclusive)",
        "format": "date"
      },
      "endDate": {
        "type": "string",
        "description": "End date for the usage report period (inclusive)",
        "format": "date"
      }
    },
    "required": [
      "startDate",
      "endDate"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "user": {
                  "type": "object",
                  "properties": {
                    "uuid": {
                      "type": "string"
                    },
                    "firstName": {
                      "type": "string"
                    },
                    "lastName": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "team": {
                      "type": "object",
                      "properties": {
                        "uuid": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                },
                "metrics": {
                  "type": "object",
                  "properties": {
                    "coachingSessions": {
                      "type": "integer"
                    },
                    "callsViewed": {
                      "type": "integer"
                    },
                    "commentsLeft": {
                      "type": "integer"
                    },
                    "snippetsCreated": {
                      "type": "integer"
                    },
                    "gInsightsRan": {
                      "type": "integer"
                    },
                    "conversationInsightsRan": {
                      "type": "integer"
                    },
                    "superAgentQueries": {
                      "type": "integer"
                    },
                    "superAgentWebQueries": {
                      "type": "integer"
                    },
                    "superAgentSlackQueries": {
                      "type": "integer"
                    },
                    "superAgentSessions": {
                      "type": "integer"
                    },
                    "superAgentWebSessions": {
                      "type": "integer"
                    },
                    "superAgentSlackSessions": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "callsViewed",
                    "coachingSessions",
                    "commentsLeft",
                    "conversationInsightsRan",
                    "gInsightsRan",
                    "snippetsCreated"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "metrics",
                "user"
              ],
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute attention_get_usage_report --payload '{
  "startDate": "string",
  "endDate": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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