XQxquik-dev
Activity

Get activity

Changed on

Returns 1 activity of the account with its full technical record. It covers every kind of activity the Activity log shows. The record holds the request, the caller, the charge, every timestamp in UTC and related activity. It never holds an API key value, a webhook secret or another account's data. Only a signed-in dashboard session sees an api_key record, so an API key or an OAuth app gets 404 for its ID.

get/api/v1/activity/{id}

Request

  • Base URL
    https://xquik.com
  • URL
    https://xquik.com/api/v1/activity/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

Activity ID. It is the id of an Activity log row and the last part of the dashboard's activity page URL.

Response

Activity record

object'activity' required
idstring required

Activity ID.

kind'write_action' | 'extraction' | 'monitor_change' | 'api_key' | 'billing' | 'giveaway_draw' | 'monitor_event' | 'media_download' | 'media_share' | 'support_ticket' | 'webhook_delivery' | 'webhook_endpoint' | 'x_account_connection' required

Kind of the activity. Only a signed-in dashboard session sees an api_key record.

typestring required

Type of the activity within its kind, the same as the type of its Activity log row. Examples are a write action type, an extraction tool type, a monitor change, a monitor event type or a ledger entry type.

status'completed' | 'running' | 'failed' | 'canceled' required
urlstring uri required

Dashboard page of this activity.

requestIdstring nullable required

ID of the API request behind this activity.

detailsobject required

Fields of this kind of activity, such as its target. A field can hold JSON, such as the data of a monitor event or the payload of a webhook delivery.

Example response

{
  "object": "activity",
  "id": "naF3xqHLWDTs",
  "kind": "monitor_change",
  "type": "pause",
  "status": "completed",
  "url": "https://dashboard.xquik.com/activity/naF3xqHLWDTs",
  "requestId": "9f2c1d7e4b8a4c55a1e0d3b2c6f7a8e9",
  "timestamps": {
    "createdAt": "2026-10-28T20:22:13.481Z"
  },
  "request": {
    "method": "PATCH",
    "path": "/api/v1/monitors/42",
    "httpStatus": 200,
    "durationMs": 37,
    "ipAddress": "203.0.113.9",
    "userAgent": "my-agent/1.0",
    "at": "2026-10-28T20:22:13.519Z"
  },
  "caller": {
    "authMethod": "api_key",
    "apiKey": {
      "name": "Production",
      "prefix": "xq_ab12"
    },
    "oauthClient": null
  },
  "charge": {
    "credits": 1300,
    "balanceAfter": 898700,
    "at": "2026-10-28T20:22:13.900Z"
  },
  "details": {
    "monitorKind": "account",
    "monitorId": "42",
    "surface": "rest"
  },
  "related": [
    {
      "id": "Q7wErTyUiOpA",
      "type": "create",
      "status": "completed",
      "createdAt": "2026-10-21T09:12:40.002Z",
      "url": "https://dashboard.xquik.com/activity/Q7wErTyUiOpA"
    }
  ]
}

Changes