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

> Report Attention usage and activity for chosen users or teams over a date range. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Report Attention usage and activity for chosen users or teams over a date range.

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

## 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(
  'attention_get_usage_report',
  {
    "startDate": "2026-01-15",
    "endDate": "2026-01-15"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute attention_get_usage_report --input '{
  "startDate": "2026-01-15",
  "endDate": "2026-01-15"
}' --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": {
    "data": [
      {
        "user": {
          "uuid": "uuid_123",
          "firstName": "Jane",
          "lastName": "Doe"
        },
        "metrics": {
          "coachingSessions": 123,
          "callsViewed": 123,
          "commentsLeft": 123,
          "snippetsCreated": 123,
          "gInsightsRan": 123,
          "conversationInsightsRan": 123
        }
      }
    ]
  }
}
```

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

## Input reference

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.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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) Format: `date`. |
| `payload.endDate` | `string` | Yes | — | End date for the usage report period (inclusive) Format: `date`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].user` | `object` | Yes | — | — |
| `result.data.data[].user.uuid` | `string` | No | — | — |
| `result.data.data[].user.firstName` | `string` | No | — | — |
| `result.data.data[].user.lastName` | `string` | No | — | — |
| `result.data.data[].user.email` | `string` | No | — | — |
| `result.data.data[].user.team` | `object` | No | — | — |
| `result.data.data[].user.team.uuid` | `string` | No | — | — |
| `result.data.data[].user.team.name` | `string` | No | — | — |
| `result.data.data[].metrics` | `object` | Yes | — | — |
| `result.data.data[].metrics.coachingSessions` | `integer` | Yes | — | — |
| `result.data.data[].metrics.callsViewed` | `integer` | Yes | — | — |
| `result.data.data[].metrics.commentsLeft` | `integer` | Yes | — | — |
| `result.data.data[].metrics.snippetsCreated` | `integer` | Yes | — | — |
| `result.data.data[].metrics.gInsightsRan` | `integer` | Yes | — | — |
| `result.data.data[].metrics.conversationInsightsRan` | `integer` | Yes | — | — |
| `result.data.data[].metrics.superAgentQueries` | `integer` | No | — | — |
| `result.data.data[].metrics.superAgentWebQueries` | `integer` | No | — | — |
| `result.data.data[].metrics.superAgentSlackQueries` | `integer` | No | — | — |
| `result.data.data[].metrics.superAgentSessions` | `integer` | No | — | — |
| `result.data.data[].metrics.superAgentWebSessions` | `integer` | No | — | — |
| `result.data.data[].metrics.superAgentSlackSessions` | `integer` | No | — | — |
| `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": {
          "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>

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

* [Attention provider guide](https://deepline.com/docs/providers/attention/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.