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

# Dashboard Summary

The `dashboardSummary` subscription allows you to generate summary of a dashboard, based on the instructions provided to it

## Signature

```graphql theme={null}
dashboardSummary(
    auth: SubscriptionAuthInput!
    id: String!
    idempotencyKey: String!
    customInstructions: String
    summaryType: DashboardSummaryType
  ): DashboardSummaryDiff! 
```

## Arguments

<ParamField path="auth" type="SubscriptionAuthInput!" required>
  Authentication credentials for the subscription. See [SubscriptionAuthInput](/integrations/graphql-api/objects/subscription-auth-input).
</ParamField>

<ParamField path="id" type="String!" required>
  The unique identifier of the dashboard whose summary is to be generated.
</ParamField>

<ParamField path="idempotencyKey" type="String!" required>
  The random string to be passed to avoid duplicate calls to the server.
</ParamField>

<ParamField path="customInstructions" type="String">
  The instructions to be followed while generating summary.
</ParamField>

<ParamField path="summaryType" type="DashboardSummaryType">
  The type of summary to be generated. See [DashboardSummaryType](/integrations/graphql-api/objects/dashboard-summary-type).
</ParamField>

## Response

Returns an array of `DashboardSummaryDiff` objects representing conversation updates. See [DashboardSummaryDiff](/integrations/graphql-api/objects/dashboard-summary-diff) for the schema.

## Usage example

A very simple example to get you started is to do the following:

```graphql theme={null}
 subscription DashboardSummary(
    $auth: SubscriptionAuthInput!,
    $id: String!,
    $idempotencyKey: String!,
    $customInstructions: String,
    $summaryType: DashboardSummaryType,
  ) {
    dashboardSummary(
      auth: $auth,
      id: $id,
      idempotencyKey: $idempotencyKey,
      customInstructions: $customInstructions,
      summaryType: $summaryType,
    ) {
      chunk
    }
  }
```

<RequestExample>
  ```bash Request theme={null}
  wscat -c wss://{ACCOUNT}.askwisdom.ai/graphql \
    -H "Authorization: Bearer <jwt_token>" \
    -s graphql-ws \
    --execute '{
      "type": "start",
      "payload": {
        "query": "subscription DashboardSummary($auth: SubscriptionAuthInput!,$id: String!,$idempotencyKey: String!, $customInstructions: String,$summaryType: DashboardSummaryType) { dashboardSummary(auth: $auth, id: $id, idempotencyKey: $idempotencyKey, customInstructions: $customInstructions, summaryType: $summaryType) { chunk }",
        "variables": {
          "auth": {
            "token": "<jwt_token>"
          },
          "id": "dash_1234",
          "idempotencyKey": "abc",
          "customInstructions": "User guidelines: ....",
        }
      }
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "dashboardSummary": [
        {
          "chunk": "The summary of",
        }
      ]
    }
  }
  ```
</ResponseExample>

## Related operation

<CardGroup cols={2}>
  <Card title="DashboardSummaryDiff Schema" icon="cube" href="/integrations/graphql-api/objects/dashboard-summary-diff">
    Learn about dashboard summary diff
  </Card>
</CardGroup>