Search

Get the configuration details required to construct a report request accurately

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

get/report/setup

Request

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

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?

Get the specific details of what filters and data is available for a given report.

Response

Details about what options are available when performing your search

groupingOptionsstring[]

What dimension do you want your data grouped by

statisticsstring[]

The list of columns that can be used to summarise your data.

Example response

{
  "groupingOptions": [
    "company_id",
    "job_status"
  ],
  "statistics": [
    "job_total_planned_time_ex_tax",
    "job_total_actual_time_ex_tax"
  ],
  "filters": [
    {
      "selector": "job_start_date",
      "name": "Job Start Date",
      "description": "The date the job started",
      "filterType": "Date"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.