> ## 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 usage stats (users and page views, 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="workspace_ids" type="string[]" required>
  Workspaces to describe. Each requested workspace is described separately in the response. 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. Pass these to measure\_audiences as restrict\_to.
    </ResponseField>

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

    <ResponseField name="stats" type="WorkspaceStats object" required>
      Usage stats for the whole workspace over the last 30 days.

      <Expandable title="WorkspaceStats">
        <ResponseField name="country_breakdown" type="CountryBreakdownEntry[]">
          Users and page views per country (ISO 3166-1 alpha-3 code), top 20 by users.

          <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[]">
          Users and page views per device type.

          <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[]">
          Users and page views per publisher domain, top 20 by users.

          <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="page_views" type="integer (int64)" required>
          Estimated page views in the workspace in the last 30 days.
        </ResponseField>

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

    <ResponseField name="tags" type="string[]">
      Cohort tags used in this workspace.
    </ResponseField>

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