action threatjammer_parse_user_agent_v1_ua_user_agent_urlencoded_get {
  label: "Get the information found in an User Agent."
  description: "### What\nGet the information found in the User Agent passed as argument. This information includes:\n- Type\n- Render Engine\n- Version\n- Vendor\n- Operating System\n- Device\n- How common is the agent worldwide\n\n\n### Parameters\nThe only argument accepted in the query string is an URL encoded User Agent string.\n\n### Result\nThe result contains the following set of data:\n\nThe result is a JSON object with the following structure:\n- ``self``: the URI of the API call\n- ``string``:  The full user agent string passed as argument.\n- ``classification``: The classification of the user agent. It can be one of the following: ``CRAWLER``, ``CLIENT``, ``UNKNOWN``.\n- ``type``: An URI to the type of user agent used to identify the client (browser, bot, crawler, etc.).\n- ``agent``: Name of the agent and the version, if any.\n- ``engine``: Agent render engine.\n- ``version``: Version of the agent.\n- ``latest``: Latests known version of the agent.\n- ``family``: URI to the family of the agent.\n- ``vendor``: URI to the vendor or company that produces the agent.\n- ``os``: URI to the operating system used by the agent.\n- ``device``: URI to the device used by the agent.\n- ``frequent``: If the agent is frequently used worlwide or not. The values are ``COMMON``, ``RARE``, and ``UNKNOWN``.\n\n\n### Errors\nThe endpoint will return the API Global errors described in the API description."
  provider: threatjammer
  method: GET
  path: "/v1/ua/{user_agent_urlencoded}"
  encoding: json
  input: {
    type: "object"
    properties: {
      user_agent_urlencoded: {
        type: "string"
      }
    }
    required: ["user_agent_urlencoded"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["agent", "classification", "device", "engine", "family", "frequent", "latest", "os", "string", "type", "vendor", "version"]
    properties: {
      agent: {
        type: "string"
      }
      classification: {
        type: "string"
        enum: ["CRAWLER", "CLIENT", "UNKNOWN"]
      }
      device: {
        type: "string"
      }
      engine: {
        type: "string"
      }
      family: {
        type: "string"
      }
      frequent: {
        type: "string"
        enum: ["COMMON", "RARE", "VERY_RARE", "UNKNOWN"]
      }
      latest: {
        type: "string"
      }
      os: {
        type: "string"
      }
      self: {
        type: "string"
      }
      string: {
        type: "string"
      }
      type: {
        type: "string"
      }
      vendor: {
        type: "string"
      }
      version: {
        type: "string"
      }
    }
  }
}