# Get metrics for a specified time period

Retrieves metrics data for the events stream within a specified time period. Supports both predefined periods (last day/week/month) and custom date ranges.

RBAC:
- requires ANY of Federation.Read, Federation.Manage

Endpoint: GET /api/v1/metrics
Version: 1.0
Security: header

## Query parameters:

  - `from` (string,null)
    Start time for custom date range (ISO 8601 format). Use with 'to' parameter.
    Example: "2022-03-10T16:15:50Z"

  - `period` (string,null)
    Predefined time period. Options: LAST_DAY, LAST_WEEK, LAST_MONTH
    Enum: "LAST_DAY", "LAST_WEEK", "LAST_MONTH"

  - `to` (string,null)
    End time for custom date range (ISO 8601 format). Use with 'from' parameter.
    Example: "2022-03-10T16:15:50Z"

## Response 200 fields (application/json):

  - `granularity` (string, required)
    Time granularity of the metrics
    Enum: "HOUR", "DAY", "MONTH"

  - `timeSlot` (string, required)
    Time slot for which metrics are calculated
    Example: "2022-03-10T16:15:50Z"

  - `newSignups` (integer,null)
    Number of new signups

  - `activeUsers` (integer,null)
    Number of active users

  - `userCreations` (integer,null)
    Number of users created

  - `userDeletions` (integer,null)
    Number of users deleted

  - `usersWhoPosted` (integer,null)
    Number of unique users who posted

  - `mediaPosts` (integer,null)
    Number of posts with media attachments

  - `likes` (integer,null)
    Number of likes

  - `reposts` (integer,null)
    Number of reposts

  - `quotes` (integer,null)
    Number of quote posts

  - `replies` (integer,null)
    Number of replies

  - `conversations` (integer,null)
    Number of conversations

  - `users` (integer,null)
    Total number of local users on this day

  - `groups` (integer,null)
    Total number of local groups (not deleted) on this day

  - `localPostsCreated` (integer,null)
    Local top-level posts created this day

  - `localPostsTotal` (integer,null)
    Cumulative local top-level posts up to this day

  - `remotePostsCreated` (integer,null)
    Remote top-level posts created this day

  - `remotePostsTotal` (integer,null)
    Cumulative remote top-level posts up to this day

  - `localComments` (integer,null)
    Comments by local users created this day

  - `remoteComments` (integer,null)
    Comments by remote users created this day

  - `localCommentsTotal` (integer,null)
    Cumulative comments by local users up to this day

  - `remoteCommentsTotal` (integer,null)
    Cumulative comments by remote users up to this day

  - `domains` (integer,null)
    Total number of external domains on this day

## Response 400 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation