tools.halowerk.com

{
  "examples": [
    {
      "client_count": 1,
      "clients": [],
      "clients_skipped": 0,
      "group_by": "ip_user_agent",
      "label_distribution": {
        "automated_purpose_unclear": 0,
        "crawler": 0,
        "human": 0,
        "scraper": 0,
        "tool": 0,
        "unknown": 1
      },
      "privacy": {
        "ip_masking": "IPv4 to /24, IPv6 to /48",
        "raw_ip_returned": false,
        "stored": false,
        "user_agent_returned": "product token only, never the full header"
      },
      "request_count": 1,
      "session_gap_s": 1800,
      "stateless": true,
      "window": {
        "first_unix_s": 1786000000,
        "last_unix_s": 1786000000
      }
    }
  ],
  "properties": {
    "client_count": {
      "minimum": 0,
      "type": "integer"
    },
    "clients": {
      "items": {
        "properties": {
          "cadence": {
            "description": "Interval statistics and regularity evidence.",
            "type": "object"
          },
          "classification": {
            "properties": {
              "automation": {
                "description": "Automation scores, winning label, lead and runner-up.",
                "type": "object"
              },
              "confidence": {
                "maximum": 1,
                "minimum": 0,
                "type": "number"
              },
              "label": {
                "enum": [
                  "human",
                  "tool",
                  "crawler",
                  "scraper",
                  "automated_purpose_unclear",
                  "unknown"
                ],
                "type": "string"
              },
              "purpose": {
                "description": "Purpose scores, winning label, lead and runner-up.",
                "type": "object"
              },
              "reasons": {
                "items": {
                  "properties": {
                    "evidence": {
                      "type": "string"
                    },
                    "favours": {
                      "type": "string"
                    },
                    "observed": {
                      "type": "string"
                    },
                    "signal": {
                      "type": "string"
                    },
                    "stage": {
                      "type": "string"
                    },
                    "weight": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "stage",
                    "signal",
                    "favours",
                    "weight",
                    "observed",
                    "evidence"
                  ],
                  "type": "object"
                },
                "type": "array"
              }
            },
            "required": [
              "label",
              "confidence",
              "automation",
              "purpose",
              "reasons"
            ],
            "type": "object"
          },
          "client": {
            "properties": {
              "grouped_by": {
                "enum": [
                  "ip",
                  "user_agent",
                  "ip_user_agent",
                  "none"
                ],
                "type": "string"
              },
              "ip_masked": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "user_agent_family": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "user_agent_family",
              "grouped_by"
            ],
            "type": "object"
          },
          "first_seen_unix_s": {
            "type": "number"
          },
          "last_seen_unix_s": {
            "type": "number"
          },
          "method_mix": {
            "description": "Write-method ratio.",
            "type": "object"
          },
          "paths": {
            "description": "Distinctness, depth, asset share and enumeration evidence.",
            "type": "object"
          },
          "request_count": {
            "minimum": 1,
            "type": "integer"
          },
          "sessions": {
            "description": "Session count, duration and request-count statistics.",
            "type": "object"
          },
          "status_mix": {
            "description": "Not-found and error ratios.",
            "type": "object"
          }
        },
        "required": [
          "client",
          "request_count",
          "first_seen_unix_s",
          "last_seen_unix_s",
          "classification",
          "cadence",
          "paths",
          "status_mix",
          "method_mix",
          "sessions"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "clients_skipped": {
      "minimum": 0,
      "type": "integer"
    },
    "group_by": {
      "enum": [
        "ip",
        "user_agent",
        "ip_user_agent",
        "none"
      ],
      "type": "string"
    },
    "label_distribution": {
      "properties": {
        "automated_purpose_unclear": {
          "minimum": 0,
          "type": "integer"
        },
        "crawler": {
          "minimum": 0,
          "type": "integer"
        },
        "human": {
          "minimum": 0,
          "type": "integer"
        },
        "scraper": {
          "minimum": 0,
          "type": "integer"
        },
        "tool": {
          "minimum": 0,
          "type": "integer"
        },
        "unknown": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "human",
        "tool",
        "crawler",
        "scraper",
        "automated_purpose_unclear",
        "unknown"
      ],
      "type": "object"
    },
    "privacy": {
      "properties": {
        "ip_masking": {
          "type": "string"
        },
        "raw_ip_returned": {
          "const": false,
          "type": "boolean"
        },
        "stored": {
          "const": false,
          "type": "boolean"
        },
        "user_agent_returned": {
          "type": "string"
        }
      },
      "required": [
        "stored",
        "raw_ip_returned",
        "ip_masking",
        "user_agent_returned"
      ],
      "type": "object"
    },
    "request_count": {
      "minimum": 1,
      "type": "integer"
    },
    "session_gap_s": {
      "maximum": 86400,
      "minimum": 60,
      "type": "integer"
    },
    "stateless": {
      "const": true,
      "type": "boolean"
    },
    "window": {
      "properties": {
        "first_unix_s": {
          "type": "number"
        },
        "last_unix_s": {
          "type": "number"
        }
      },
      "required": [
        "first_unix_s",
        "last_unix_s"
      ],
      "type": "object"
    }
  },
  "required": [
    "request_count",
    "client_count",
    "clients_skipped",
    "group_by",
    "session_gap_s",
    "window",
    "label_distribution",
    "clients",
    "privacy",
    "stateless"
  ],
  "type": "object"
}