---
title: "Run a catalog report"
method: GET
path: "/reports/{slug}"
tags: ["Reports"]
---

# Run a catalog report

`GET /reports/{slug}`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/reports/{slug}`
- Auth: HTTP bearer

KPIs, series and up to 500 rows for one report. Money values are decimal strings. `groupBy` must be one of the catalog entry's groupBys.

## Path parameters

- `slug` 'ar-aging' | 'billed-vs-collected' | 'bid-performance' | 'pipeline' | 'wip', required

## Query parameters

- `dateFrom` string, date-time
- `dateTo` string, date-time
- `date` string
- `tz` string
- `preset` string
- `compare` boolean
- `groupBy` string
- `customerId` integer
- `projectId` integer
- `estimatorId` integer
- `source` string
- `status` string
- `projectType` string
- `includeCompleted` boolean
- `limit` integer
- `sort` string

## Response `200`

Report payload

- object
  - `data` object, required
    - `slug` 'ar-aging' | 'billed-vs-collected' | 'bid-performance' | 'pipeline' | 'wip', required
    - `window` object, required
      - `from` string, required
      - `to` string, required
      - `label` string, required
    - `compareWindow` object
      - `from` string, required
      - `to` string, required
      - `label` string, required
    - `kpis` object[], required
      - `key` string, required
      - `label` string, required
      - `definition` string, required
      - `value` string, required
      - `kind` 'money' | 'count' | 'percent' | 'days', required
      - `detail` string
      - `linkTo` string
      - `delta` object
        - `kind` 'percent' | 'money', required
        - `value` string, required
        - `direction` 'up' | 'down' | 'flat', required
        - `goodWhen` 'up' | 'down', required
    - `series` object[]
      - `bucket` string, required
      - `label` string, required
      - `values` object, required
      - `compareValues` object
    - `rows` object[], required
    - `totals` object
    - `hasMore` boolean, required
    - `meta` object, required
      - `scope` 'tenant' | 'own' | 'assigned', required
      - `definitions` object, required
      - `groupBy` string, required
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `403`: Error
- `404`: Error
- `422`: Error

---

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