---
title: "Week"
method: GET
path: "/v1/today/week"
tags: ["Owner"]
---

# Week

`GET /v1/today/week`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/today/week`
- Auth: HTTP bearer

## Query parameters

- `span` 'week' | 'month'
- `from` string
- `to` string

## Response `200`

OK

- WeekResponse
  - `span` 'week' | 'month', required
  - `from` string, required
  - `to` string, required
  - `figures` DayFigures, required
    - `calls` integer, required
    - `handled` integer, required
    - `needsYou` integer, required
    - `booked` integer, required
    - `messages` integer, required
    - `scamsStopped` integer, required
    - `silentCalls` integer, required
    - `callsForYou` integer, required
    - `newPeople` integer, required
    - `minutesSaved` integer, required
  - `days` object[], required
    - `day` string, required
    - `calls` integer, required
  - `best` object, nullable, required
    - `text` string, required
    - `interactionId` string, required
    - `at` string, date-time, required
  - `learned` string, nullable
  - `howWeCount` string
  - `handle` string, nullable, required
  - `ownerName` string, nullable, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `500`: Unexpected server error (reported to Sentry).

---

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