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

# Get Workspace Details

**Tool name** `get_workspace_details`

<Info>Read-only · Idempotent</Info>

Describes one or more workspaces: each one's name, the publisher domains it collects data on, the cohort tags used in it, and its reach (users and page views, whole-workspace and broken down by domain, device, and country).

## Example prompt

> Which domains do we serve from our UK workspace? What's the geographical coverage for the News workspace?

## Parameters

<ParamField body="include" type="enum[]">
  Which parts of each requested workspace's description to return. Omit to return all of them. each one of: `domains`, `tags`, `reach_total`, `reach_domain_breakdown`, `reach_device_breakdown`, `reach_country_breakdown`.
</ParamField>

<ParamField body="workspace_ids" type="string[]" required>
  Workspaces to describe. Each requested workspace is described separately in the response, so pass every workspace you were asked about in one call rather than calling once per workspace. min 1 item.
</ParamField>

## Returns

<ResponseField name="workspaces" type="WorkspaceDetail[]">
  One entry per requested workspace, in the order requested.

  <Expandable title="WorkspaceDetail">
    <ResponseField name="domains" type="string[]">
      Publisher domains this workspace collects data on. These are the valid values for a restrict\_to domain filter. Present only if "domains" is in include.
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Workspace name.
    </ResponseField>

    <ResponseField name="reach" type="WorkspaceReach object">
      How many users and page views the workspace saw over the last 30 days. Present only if at least one "reach\_\*" value is in include.

      <Expandable title="WorkspaceReach">
        <ResponseField name="country_breakdown" type="CountryBreakdownEntry[]">
          Reach per country (ISO 3166-1 alpha-3 code), top 20 by users. These are the countries the workspace has data for, so they are the values worth passing to a restrict\_to country filter. Present only if "reach\_country\_breakdown" is in include.

          <Expandable title="CountryBreakdownEntry">
            <ResponseField name="country" type="string" required>
              ISO 3166-1 alpha-3 country code (e.g. GBR, USA).
            </ResponseField>

            <ResponseField name="page_views" type="integer (int64)" required>
              Estimated page views in this country.
            </ResponseField>

            <ResponseField name="users" type="integer (int64)" required>
              Estimated unique users in this country.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="device_breakdown" type="DeviceBreakdownEntry[]">
          Reach per device type. Present only if "reach\_device\_breakdown" is in include.

          <Expandable title="DeviceBreakdownEntry">
            <ResponseField name="device" type="string" required>
              Device type (e.g. Desktop, Mobile, Tablet, CTV).
            </ResponseField>

            <ResponseField name="page_views" type="integer (int64)" required>
              Estimated page views on this device type.
            </ResponseField>

            <ResponseField name="users" type="integer (int64)" required>
              Estimated unique users on this device type.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="domain_breakdown" type="DomainBreakdownEntry[]">
          Reach per publisher domain, top 20 by users. Present only if "reach\_domain\_breakdown" is in include.

          <Expandable title="DomainBreakdownEntry">
            <ResponseField name="domain" type="string" required>
              Publisher domain name.
            </ResponseField>

            <ResponseField name="page_views" type="integer (int64)" required>
              Estimated page views on this domain.
            </ResponseField>

            <ResponseField name="users" type="integer (int64)" required>
              Estimated unique users on this domain.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="total" type="WorkspaceReachTotal object">
          Reach for the whole workspace, undivided. Present only if "reach\_total" is in include.

          <Expandable title="WorkspaceReachTotal">
            <ResponseField name="page_views" type="integer (int64)" required>
              Estimated page views in the workspace.
            </ResponseField>

            <ResponseField name="users" type="integer (int64)" required>
              Estimated unique users active in the workspace.
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="tags" type="string[]">
      Cohort tags used in this workspace. These are the valid values for a cohort tags filter. Present only if "tags" is in include.
    </ResponseField>

    <ResponseField name="workspace_id" type="string (uuid)" required>
      The workspace these details describe.
    </ResponseField>
  </Expandable>
</ResponseField>


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