Skip to main content
POST

Region Discovery Request

/v6/intelligence/insight

Description

Routes requests based on `insight_intent`.

Request Schema

{
  "insight_intent": {
    "type": "string",
    "enum": [
      "region_discovery",
      "report",
      "insight_status"
    ],
    "description": "The intent of the api"
  },
  "reference_id": {
    "type": "string",
    "description": "Unique identifier for the batch/request"
  },
  "member_id": {
    "type": "string",
    "description": "Optional member identifier"
  },
  "insight_scope": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "region_id": {
          "type": "string"
        },
        "unique_identifier": {
          "type": "string"
        }
      }
    }
  },
  "insight_protocol": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "report_template_code": {
          "type": "integer"
        },
        "depth": {
          "type": "integer"
        },
        "geometry": {
          "type": "boolean"
        },
        "media_type": {
          "type": "string"
        },
        "mode": {
          "type": "string",
          "enum": [
            "sync",
            "async"
          ]
        },
        "delivery": {
          "type": "string"
        },
        "encryption": {
          "type": "boolean"
        },
        "callback_url": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string"
            },
            "headers": {
              "type": "object"
            }
          }
        }
      }
    }
  }
}

API Runner