# pub.chive.activity.getCorrelationMetrics

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.activity.getCorrelationMetrics)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.activity.getCorrelationMetrics/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.activity.getCorrelationMetrics/examples)

## Definitions

### `pub.chive.activity.getCorrelationMetrics`

**Type**: `query`

Get activity correlation metrics showing confirmation rates, latencies, and error counts by category (admin only)

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `metrics` | `array` | Yes |  |
| `pendingCount` | `integer` | Yes | Current count of pending activities |

#### Errors

- **AuthenticationRequired**
- **AuthorizationRequired**

### `pub.chive.activity.getCorrelationMetrics#metricsEntry`

**Type**: `object`

Correlation metrics for a time bucket and category

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `hour` | `string` (datetime) | Yes | Hour bucket timestamp |
| `total` | `integer` | Yes | Total activities in this bucket |
| `failed` | `integer` | Yes | Number of failed activities |
| `pending` | `integer` | Yes | Number of pending activities |
| `timeout` | `integer` | Yes | Number of timed out activities |
| `category` | `string` | Yes | Activity category |
| `confirmed` | `integer` | Yes | Number of confirmed activities |
| `avgLatencyMs` | `integer` | No | Average latency in milliseconds |
| `p95LatencyMs` | `integer` | No | 95th percentile latency in milliseconds |
| `confirmationRatePct` | `integer` | Yes | Confirmation rate as percentage (0-100) |

## Raw Schema

```json
{
  "id": "pub.chive.activity.getCorrelationMetrics",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "AuthorizationRequired"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "metrics",
            "pendingCount"
          ],
          "properties": {
            "metrics": {
              "type": "array",
              "items": {
                "ref": "#metricsEntry",
                "type": "ref"
              }
            },
            "pendingCount": {
              "type": "integer",
              "description": "Current count of pending activities"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {}
      },
      "description": "Get activity correlation metrics showing confirmation rates, latencies, and error counts by category (admin only)"
    },
    "metricsEntry": {
      "type": "object",
      "required": [
        "hour",
        "category",
        "total",
        "confirmed",
        "failed",
        "timeout",
        "pending",
        "confirmationRatePct"
      ],
      "properties": {
        "hour": {
          "type": "string",
          "format": "datetime",
          "description": "Hour bucket timestamp"
        },
        "total": {
          "type": "integer",
          "description": "Total activities in this bucket"
        },
        "failed": {
          "type": "integer",
          "description": "Number of failed activities"
        },
        "pending": {
          "type": "integer",
          "description": "Number of pending activities"
        },
        "timeout": {
          "type": "integer",
          "description": "Number of timed out activities"
        },
        "category": {
          "type": "string",
          "description": "Activity category",
          "knownValues": [
            "eprint_submit",
            "eprint_update",
            "eprint_delete",
            "review_create",
            "review_update",
            "review_delete",
            "endorsement_create",
            "endorsement_delete",
            "tag_create",
            "tag_delete",
            "profile_update",
            "proposal_create",
            "vote_create"
          ]
        },
        "confirmed": {
          "type": "integer",
          "description": "Number of confirmed activities"
        },
        "avgLatencyMs": {
          "type": "integer",
          "description": "Average latency in milliseconds"
        },
        "p95LatencyMs": {
          "type": "integer",
          "description": "95th percentile latency in milliseconds"
        },
        "confirmationRatePct": {
          "type": "integer",
          "description": "Confirmation rate as percentage (0-100)"
        }
      },
      "description": "Correlation metrics for a time bucket and category"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```