Akamai · Schema

Final metadata line

This object features contextual metadata about the set of security events included in each response and appears on the last line of the response body.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
limit integer Appears if the size limit was reached during data fetch.
offset string Identifies the last processed security event in a response. To fetch only those security events that occurred since the last pull, enter this value as an offset parameter.
total integer The number of security events included in the response.
View JSON Schema on GitHub

JSON Schema

siem-siem-response-context-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai/main/json-schema/siem-siem-response-context-schema.json",
  "title": "Final metadata line",
  "additionalProperties": false,
  "description": "This object features contextual metadata about the set of security events included in each response and appears on the last line of the response body.",
  "properties": {
    "limit": {
      "description": "Appears if the size limit was reached during data fetch.",
      "maximum": 600000,
      "type": "integer"
    },
    "offset": {
      "description": "Identifies the last processed security event in a response. To fetch only those security events that occurred since the last pull, enter this value as an offset parameter.",
      "type": "string"
    },
    "total": {
      "description": "The number of security events included in the response.",
      "type": "integer"
    }
  },
  "required": [
    "total",
    "limit",
    "offset"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/siem-response-context.yaml"
  }
}