---
title: "Retrieve user metrics for OnlyFans platform"
method: GET
path: "/api/v0/users/metrics"
tags: ["statistics"]
---

# Retrieve user metrics for OnlyFans platform

`GET /api/v0/users/metrics`

## Request

- Base URL: `https://omapi.onlymonster.ai`
- URL: `https://omapi.onlymonster.ai/api/v0/users/metrics`
- Auth: API key in header `x-om-auth-token`

**Rate limit:** 15 requests per second

**Required permission:** `team_metrics.view`

## Query parameters

- `from` string, date-time, required
- `to` string, date-time, required
- `creator_ids` integer[]
- `user_ids` integer[]
- `account_group_id` integer
- `role_id` integer
- `offset` integer, required
- `limit` integer, required

## Response `200`

User metrics successfully retrieved.

- object
  - `items` object[], required
    - `user_id` integer, required: User ID
    - `creator_ids` integer[], required: Array of creator IDs
    - `fans_count` integer: Same value as `chats_count`; use `chats_count` instead
    - `chats_count` integer: Total Chats: number of fans the member sent at least one message to, counted per account and summed over the accounts. Mass, auto and priority campaign messages are excluded; AI, copied and template messages are included
    - `messages_count` integer: Total number of messages sent
    - `template_messages_count` integer: Number of template messages sent
    - `ai_generated_messages_count` integer: Number of AI-generated messages
    - `copied_messages_count` integer: Number of copied messages
    - `media_messages_count` integer: Number of messages with media
    - `paid_messages_count` integer: Number of paid messages sent
    - `free_media_messages_count` integer: Number of sent messages with media attached and no price (free media); campaign sends excluded, media minus this is the number of paid messages with media
    - `paid_messages_price_sum` number: Total sum of paid messages prices
    - `words_count_sum` integer: Word count of manually typed messages. AI replies, copy-pasted messages, OnlyFans templates and internal templates are excluded
    - `typed_messages_count` integer: Number of manually typed messages, same exclusions as words_count_sum; the denominator for the words average
    - `unsent_messages_count` integer: Number of unsent messages
    - `purchase_interval_avg` number: Average purchase interval in seconds
    - `reply_time_avg` number: Average reply time in seconds
    - `posts_count` integer: Total number of posts
    - `deleted_posts_count` integer: Number of deleted posts
    - `work_time` number: Total work time
    - `break_time` number: Total break time
    - `sold_messages_count` integer: Number of messages sold
    - `sold_messages_price_sum` number: Total price of messages sold
    - `total_sold_messages_count` integer: Total count of all sold messages
    - `total_sold_messages_price_sum` number: Total price sum of all sold messages
    - `purchase_interval_min` integer: Minimum purchase interval
    - `purchase_interval_max` integer: Maximum purchase interval
    - `sold_posts_count` integer: Number of posts sold
    - `sold_posts_price_sum` number: Total price of posts sold
    - `total_sold_posts_count` integer: Total count of all sold posts
    - `tips_amount_sum` number: Total sum of tips received
    - `total_tips_amount_sum` number: Total sum of all tips
    - `chargedback_tips_amount_sum` number: Total sum of chargedback tips
    - `chargedback_posts_price_sum` number: Total price sum of chargedback posts
    - `chargedback_posts_count` integer: Number of chargedback posts
    - `chargedback_messages_price_sum` number: Total price sum of chargedback messages
    - `chargedback_messages_count` integer: Number of chargedback messages
    - `total_chargedback_tips_amount_sum` number: Total sum of all chargedback tips
    - `total_chargedback_posts_price_sum` number: Total price sum of all chargedback posts
    - `total_chargedback_posts_count` integer: Total count of all chargedback posts
    - `total_chargedback_messages_price_sum` number: Total price sum of all chargedback messages
    - `total_chargedback_messages_count` integer: Total count of all chargedback messages
    - `internal_templates_count` number: Number of internal templates used

## Other responses

- `403`: The API key lacks the permission this endpoint requires, or the request is outside what the organisation or the API key can access.

## Changes

- **2026-11-03** `20f58411c6c5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/onlymonster/apis/om-api-service/changes/api/v0/users/metrics/get.md)

---

[API](https://skmtc.dev/onlymonster/apis/om-api-service.md) - [All operations](https://skmtc.dev/onlymonster/apis/om-api-service/llms.txt) - [OpenAPI document](https://skmtc.dev/onlymonster/apis/om-api-service/revisions/0003edb0288a?raw)