---
title: "Get the configuration details required to construct a report request accurately"
method: GET
path: "/report/setup"
tags: ["Search"]
---

# Get the configuration details required to construct a report request accurately

`GET /report/setup`

## Request

- Base URL: `https://api.streamtime.net/v2`
- URL: `https://api.streamtime.net/v2/report/setup`
- Auth: HTTP bearer

This route gives you the required background information in order to perform a report.

## Query parameters

- `search_view` 'jobs' | 'job_items' | 'job_item_users' | 'job_item_roles' | 'time' | 'expenses' | 'quotes' | 'invoices' | 'job_groups' | 'companies' | 'contacts' | 'users', required: What are you reporting on?

## Response `200`

Details about what options are available when performing your search

- object
  - `groupingOptions` string[]: What dimension do you want your data grouped by
  - `statistics` string[]: The list of columns that can be used to summarise your data.
  - `filters` object[]: A list of filters to choose from with details about each type
    - `selector` string: The name to be used when constructing a search
    - `name` string
    - `description` string
    - `filterType` string

---

[API](https://skmtc.dev/streamtime/apis/public-api.md) · [All operations](https://skmtc.dev/streamtime/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/streamtime/apis/public-api/revisions/cda8d1405534?raw)