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

# get_report

Return one report's full detail: the list summary plus its configuration.

The natural follow-up to `list_reports`: take a report and read how it is
built — its columns and their types, the filters and sort applied, the
bottom-of-column aggregates, and the pivot-table / chart layout when configured.
This is the configuration that makes the report's data interpretable; the
computed rows and pivot cells live behind `get_report_data` and
`get_report_pivot_data`.

`access` (who can view the report) is only returned to callers with write
access on reports; read-only callers get `access: null`.

## Parameters

<Accordion title="Body" defaultOpen>
  <ParamField body="report" type="string" required>
    The report to read. Accepts the report's ObjectId (the id returned by
    list\_reports) or a case- and accent-insensitive substring of its name. A
    name matching no — or more than one — report raises a clear error; pass the
    full id to disambiguate.
  </ParamField>
</Accordion>

## Response

<Accordion title="Body" defaultOpen>
  <ResponseField name="report_id" type="string" />

  <ResponseField name="report_name" type="string" />

  <ResponseField name="description" type="string" />

  <ResponseField name="report_type" type="string" />

  <ResponseField name="calculation_currency" type="string" />

  <ResponseField name="section" type="object">
    <Expandable title="object properties">
      <ResponseField name="section_id" type="string" />

      <ResponseField name="section_name" type="string" />
    </Expandable>
  </ResponseField>

  <ResponseField name="access" type="object">
    <Expandable title="object properties">
      <ResponseField name="roles" type="object[]">
        <Expandable title="object properties">
          <ResponseField name="role_id" type="string" />

          <ResponseField name="role_name" type="string" />

          <ResponseField name="role_access" type="string">
            One of: `read`, `write`, `delete`.
          </ResponseField>

          <ResponseField name="sharing_access" type="string">
            One of: `read`, `write`, `delete`.
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="users" type="object[]">
        <Expandable title="object properties">
          <ResponseField name="user_id" type="string" />

          <ResponseField name="user_name" type="string" />

          <ResponseField name="sharing_access" type="string">
            One of: `read`, `write`, `delete`.
          </ResponseField>
        </Expandable>
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="report_fields" type="object[]" />

  <ResponseField name="bottom_aggregates" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="field_id_aggregated" type="string" />

      <ResponseField name="aggregation_operator" type="string" />
    </Expandable>
  </ResponseField>

  <ResponseField name="report_sorts" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="field_id" type="string" />

      <ResponseField name="order" type="string" />
    </Expandable>
  </ResponseField>

  <ResponseField name="filters" type="object">
    <Expandable title="object properties">
      <ResponseField name="link" type="string">
        One of: `AND`, `OR`.
      </ResponseField>

      <ResponseField name="filters" type="object[]" />
    </Expandable>
  </ResponseField>

  <ResponseField name="chart_options" type="object" />

  <ResponseField name="pivot_table_configuration" type="object">
    <Expandable title="object properties">
      <ResponseField name="groups" type="object[]">
        <Expandable title="object properties">
          <ResponseField name="field_id_to_group" type="string" />

          <ResponseField name="field_name_to_group" type="string" />

          <ResponseField name="group_position" type="string" />

          <ResponseField name="date_grouping_option" type="string" />

          <ResponseField name="show_totals" type="boolean" />

          <ResponseField name="sort" type="object">
            <Expandable title="object properties">
              <ResponseField name="sort_order" type="string" />

              <ResponseField name="sort_by_measure" type="object">
                <Expandable title="object properties">
                  <ResponseField name="measure_field_id" type="string" />

                  <ResponseField name="measure_name" type="string" />
                </Expandable>
              </ResponseField>
            </Expandable>
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="measures" type="object">
        <Expandable title="object properties">
          <ResponseField name="measures_position" type="string" />

          <ResponseField name="aggregations" type="object[]">
            <Expandable title="object properties">
              <ResponseField name="measure_field_id" type="string" />

              <ResponseField name="measure_name" type="string" />

              <ResponseField name="field_id_to_aggregate" type="string" />

              <ResponseField name="field_name_to_aggregate" type="string" />

              <ResponseField name="measure_operator" type="string" />

              <ResponseField name="totals_operator" type="string" />

              <ResponseField name="display_index" type="integer" />

              <ResponseField name="is_displayed" type="boolean" />
            </Expandable>
          </ResponseField>

          <ResponseField name="calculated_fields" type="object[]">
            <Expandable title="object properties">
              <ResponseField name="measure_field_id" type="string" />

              <ResponseField name="measure_name" type="string" />

              <ResponseField name="display_index" type="integer" />

              <ResponseField name="is_displayed" type="boolean" />
            </Expandable>
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="pivot_table_fields" type="object[]" />
    </Expandable>
  </ResponseField>

  <ResponseField name="resource_url" type="string" />

  <ResponseField name="reporting_table" type="string" />
</Accordion>
