---
title: "Value report"
method: GET
path: "/v1/me/value"
tags: ["Owner"]
---

# Value report

`GET /v1/me/value`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/me/value`
- Auth: HTTP bearer

## Query parameters

- `from` string
- `to` string

## Response `200`

OK

- ValueReportResponse
  - `period` 'week' | 'month', required
  - `title` string, required
  - `from` string, required
  - `to` string, required
  - `dates` string, required
  - `figures` object[], required
    - `key` 'calls' | 'messages' | 'bookings' | 'scams' | 'minutes' | 'people', required
    - `count` integer, required
    - `text` string, required
    - `href` string, nullable, required
  - `lead` string, required
  - `howWeCount` object, required
    - `title` string, required
    - `text` string, required
  - `moment` object, nullable, required
    - `text` string, required
    - `href` string, nullable, required
    - `title` string, required
  - `quiet` object, nullable, required
    - `text` string, required
    - `tip` object, required
      - `text` string, required
      - `href` string, nullable, required
  - `plan` string, nullable, required
  - `saves` object[]
    - `key` 'after_hours' | 'phone_off' | 'junk_silent' | 'real_unknowns', required
    - `count` integer, required
    - `text` string, required
    - `href` string, required
  - `strip` object, required
    - `label` string, required
    - `items` object[], required
      - `key` 'calls' | 'messages' | 'bookings' | 'scams' | 'minutes' | 'people', required
      - `count` integer, required
      - `text` string, required
      - `href` string, nullable, required
  - `errands` object, nullable
    - `total` integer, required
    - `done` integer, required
    - `refused` integer, required
    - `text` string, required
  - `jobHunt` object, nullable
    - `title` string, required
    - `recruiters` integer, required
    - `screensBooked` integer, required
    - `scamsStopped` integer, required
    - `lines` string[], required
  - `visits` object, nullable
    - `title` string, required
    - `confirmed` integer, required
    - `reviewsAsked` integer, required
    - `lines` string[], required
  - `learned` object, nullable
    - `text` string, required
    - `factId` string, nullable, required
    - `at` string, date-time, required
  - `tiles` object[]
    - `key` 'calls' | 'helped' | 'stopped' | 'bookings' | 'messages' | 'minutes', required
    - `count` integer, required
    - `value` string, required
    - `label` string, required
    - `change` integer, nullable, required
    - `changeText` string, nullable, required
    - `href` string, nullable, required
  - `tilesNote` string, nullable
  - `improve` object, nullable
    - `key` 'callback' | 'forwarding' | 'screened' | 'question', required
    - `title` string, required
    - `text` string, required
    - `action` string, required
    - `href` string, required
  - `bookingValue` object, nullable
    - `text` string, required
    - `amount` number, required
    - `currency` string, required
    - `counted` integer, required
    - `total` integer, required
  - `scorecard` object, nullable
    - `title` string, required
    - `rows` object[], required
      - `key` 'answer' | 'resolved' | 'passed' | 'complete' | 'spam_free' | 'booked', required
      - `label` string, required
      - `value` string, required
      - `href` string, nullable, required
  - `share` object
    - `calls` integer, required
    - `scams` integer, required
  - `kindLine` string, nullable

## 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)