---
title: "One weekly brief: change counts per tracked brand for the period and up to ten notable radar items."
method: GET
path: "/v1/workspaces/{ws}/briefs/{briefId}"
tags: ["briefs"]
---

# One weekly brief: change counts per tracked brand for the period and up to ten notable radar items.

`GET /v1/workspaces/{ws}/briefs/{briefId}`

## Request

- Base URL: `https://api.storequant.com`
- URL: `https://api.storequant.com/v1/workspaces/{ws}/briefs/{briefId}`
- Auth: HTTP bearer

One weekly brief: change counts per tracked brand for the period and up to ten notable radar items. Scope `briefs:read`; cache `none`.

## Path parameters

- `ws` string, required
- `briefId` string, uuid, required

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, uuid, required
    - `title` string, required
    - `period_start` string, date, required
    - `period_end` string, date, required
    - `brand_count` integer, required
    - `totals` object, required
      - `ad_started` integer, required
      - `ad_stopped` integer, required
      - `ad_destination_changed` integer, required
    - `feedback` 'useful' | 'already_known' | 'wrong', nullable, required
    - `created_at` string, date-time, required
    - `url` string, uri, required
    - `body` object, required
      - `totals` object, required
        - `ad_started` integer, required
        - `ad_stopped` integer, required
        - `ad_destination_changed` integer, required
      - `brands` object[], required
        - `brand` object, required
          - `id` string, uuid, required
          - `slug` string, required
          - `name` string, required
          - `logo_url` string, uri, nullable, required
          - `url` string, uri, required
        - `changes` object, required
          - `ad_started` integer, required
          - `ad_stopped` integer, required
          - `ad_destination_changed` integer, required
      - `notable` object[], required
        - `change` 'ad_started' | 'ad_stopped' | 'ad_destination_changed' | 'offer_sale_started' | 'offer_discount_started' | 'offer_code_new' | 'offer_ended' | 'offer_free_shipping_threshold_changed', required
        - `date` string, date, required
        - `brand` object, required
          - `id` string, uuid, required
          - `slug` string, required
          - `name` string, required
          - `logo_url` string, uri, nullable, required
          - `url` string, uri, required
        - `ad` object, nullable, required
          - `id` string, required
          - `title` string, nullable, required
          - `link_url` string, nullable, required
          - `url` string, uri, required
        - `previous_link_url` string, nullable, required
        - `offer` object
          - `kind` 'free_shipping' | 'discount_pct' | 'discount_amt' | 'code' | 'subscribe_save' | 'bundle_bogo' | 'guarantee' | 'signup_offer' | 'sale_event', required
          - `value` string, nullable, required
          - `previous_value` string, nullable, required
          - `host` string, required
      - `truncated` boolean, required
  - `meta` object, required
    - `request_id` string, required
    - `as_of` string, date-time, required
    - `lag_hours` number
    - `cursor` string
    - `count` integer

## Other responses

- `4XX`: The one error shape.
- `5XX`: The one error shape.

---

[API](https://skmtc.dev/scrollstash/apis/storequant-api.md) · [All operations](https://skmtc.dev/scrollstash/apis/storequant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrollstash/apis/storequant-api/revisions/4d67a114a13c?raw)