Skip to main content
GET
/
analysis
/
types
/
{type}
Get parameter schema for an analysis type
curl --request GET \
  --url https://{hostname}/v1/analysis/types/{type} \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "status": "available",
  "description": "<string>",
  "subject_types": [
    "entity"
  ],
  "parameters": {},
  "result_description": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT issued by your organization's SAML/OIDC identity provider after authentication. Required for user-attributed queries. The sub claim is recorded verbatim in the audit trail.

Path Parameters

​
type
string
required

The analysis type identifier, as returned by GET /analysis/types.

Response

Analysis type detail returned.

​
type
string
required
​
status
enum<string>
required
  • available: fully supported and recommended for production use
  • beta: available for use but the interface or result structure may change
  • deprecated: will be removed in a future release; migrate to the replacement type indicated in the description
Available options:
available,
beta,
deprecated
​
description
string
required
​
subject_types
string[]
Example:
["entity"]
​
parameters
object

A JSON Schema object describing the parameters this analysis type accepts. Use this to validate your parameters payload before submission.

​
result_description
string

Narrative description of the result.data structure for this type. The result schema is intentionally not enforced by the API contract. It is documented here for reference only and may evolve as the analysis type develops.