Skip to Content
ReferenceAPI referenceIntegrations

Get a compact dashboard overview

GET
/api/v1/integration/summary

Traffic, instances, local ingestion and active CrowdSec decisions in one response. window defaults to 24h and supports up to 365 days. Traffic uses analytics/summary semantics, including whole aggregate buckets above 24 hours. latestEventAt is retained log time, not commit time. Agent freshness comes from heartbeats; local ingestion describes only this process. Each section has available, reason and data; unavailable data is null, not zero. Sections are observed sequentially. Database sections have a three-second deadline each and the CrowdSec count makes one LAPI request with a two-second deadline.

Authorization

cookiesession<token>

Session cookie authentication.

Query Parameters

window?|

A rolling window ending now, such as 15m, 24h or 7d, up to 365 days. Use positive whole minutes, hours or days. Cannot be combined with explicit time bounds.

Default"24h"

Response Body

Request fulfilled, document follows

application/json
  1. response

A dashboard overview whose sections are observed in sequence, not one atomic snapshot.

crowdsec*

Unavailable sections have a reason and null data; available sections may contain zero counts.

endDate*string
Formatdate-time
generatedAt*string
Formatdate-time
ingestion*

This head process only. Agent ingestion freshness is in instances.items[].lastParsedAt.

instances*

Unavailable sections have a reason and null data; available sections may contain zero counts.

startDate*string
Formatdate-time
traffic*

Unavailable sections have a reason and null data; available sections may contain zero counts.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/integration/summary'
Example Response
{  "crowdsec": {    "available": true,    "data": {      "activeDecisions": 0,      "checkedAt": "2019-08-24T14:15:22Z",      "writeEnabled": true    },    "reason": "disabled"  },  "endDate": "2019-08-24T14:15:22Z",  "generatedAt": "2019-08-24T14:15:22Z",  "ingestion": {    "available": true,    "data": {      "failedBatches": 0,      "failedRecords": 0,      "lastRecordAt": "string",      "missingFiles": [        "string"      ],      "parsedLines": 0,      "pendingRecords": 0,      "publishDropped": 0,      "running": true,      "status": "running",      "unavailableSources": [        {          "kind": "string",          "label": "string",          "reason": "string"        }      ]    },    "reason": "disabled"  },  "instances": {    "available": true,    "data": {      "checkedAt": "2019-08-24T14:15:22Z",      "checkingIn": 0,      "critical": 0,      "items": [        {          "checkingIn": true,          "instanceName": "string",          "lastParsedAt": "string",          "lastSeen": "2019-08-24T14:15:22Z",          "mode": "string",          "status": "ok"        }      ],      "total": 0,      "warning": 0    },    "reason": "disabled"  },  "startDate": "2019-08-24T14:15:22Z",  "traffic": {    "available": true,    "data": {      "latestEventAt": "2019-08-24T14:15:22Z",      "totals": {        "avgBytesPerRequest": 0,        "avgRequestTime": 0,        "errorRate": 0,        "malformedRequests": 0,        "maxRequestTime": 0,        "status2xx": 0,        "status3xx": 0,        "status4xx": 0,        "status5xx": 0,        "timedRequests": 0,        "totalBytesSent": 0,        "totalGeoEvents": 0,        "totalRequests": 0,        "uniqueCountries": 0,        "uniqueIps": 0      }    },    "reason": "disabled"  }}