pub.chive.activity.getCorrelationMetrics Documentation (EN)

main query

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

Output

Encodingapplication/json

metrics array Required

No description available.

pendingCount integer Required

Current count of pending activities

Errors

AuthenticationRequired

AuthorizationRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "description": "Get activity correlation metrics showing confirmation rates, latencies, and error counts by category (admin only)",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AuthorizationRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "metrics": {
          "items": {
            "ref": "#metricsEntry",
            "type": "ref"
          },
          "type": "array"
        },
        "pendingCount": {
          "description": "Current count of pending activities",
          "type": "integer"
        }
      },
      "required": [
        "metrics",
        "pendingCount"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {},
    "type": "params"
  },
  "type": "query"
}

metricsEntry object

Correlation metrics for a time bucket and category

Properties

avgLatencyMs integer Optional

Average latency in milliseconds

category string Required

Activity category

Known values: 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

confirmationRatePct integer Required

Confirmation rate as percentage (0-100)

confirmed integer Required

Number of confirmed activities

failed integer Required

Number of failed activities

hour string datetime Required

Hour bucket timestamp

p95LatencyMs integer Optional

95th percentile latency in milliseconds

pending integer Required

Number of pending activities

timeout integer Required

Number of timed out activities

total integer Required

Total activities in this bucket

View raw schema

{
  "description": "Correlation metrics for a time bucket and category",
  "properties": {
    "avgLatencyMs": {
      "description": "Average latency in milliseconds",
      "type": "integer"
    },
    "category": {
      "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"
      ],
      "type": "string"
    },
    "confirmationRatePct": {
      "description": "Confirmation rate as percentage (0-100)",
      "type": "integer"
    },
    "confirmed": {
      "description": "Number of confirmed activities",
      "type": "integer"
    },
    "failed": {
      "description": "Number of failed activities",
      "type": "integer"
    },
    "hour": {
      "description": "Hour bucket timestamp",
      "format": "datetime",
      "type": "string"
    },
    "p95LatencyMs": {
      "description": "95th percentile latency in milliseconds",
      "type": "integer"
    },
    "pending": {
      "description": "Number of pending activities",
      "type": "integer"
    },
    "timeout": {
      "description": "Number of timed out activities",
      "type": "integer"
    },
    "total": {
      "description": "Total activities in this bucket",
      "type": "integer"
    }
  },
  "required": [
    "hour",
    "category",
    "total",
    "confirmed",
    "failed",
    "timeout",
    "pending",
    "confirmationRatePct"
  ],
  "type": "object"
}