Skip to main content
POST
/
analysis
curl --request POST \
  --url https://{hostname}/v1/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": {
    "type": "entity",
    "entity_id": "ent_01JNQBC4X8Y2Z3B"
  },
  "analysis_type": "network_centrality"
}
'
{
  "analysis_id": "ana_01JNQBC4X8Y2Z3D",
  "analysis_type": "<string>",
  "status": "complete",
  "subject": {
    "type": "entity",
    "entity_id": "ent_01JNQBC4X8Y2Z3B"
  },
  "queried_at": "2026-02-19T14:23:00Z",
  "audit": {
    "request_id": "req_01JNQBC4X8Y2Z3A",
    "principal": {
      "type": "user",
      "user_id": "u_analyst_jdoe",
      "user_email": "analyst@example.com",
      "idp_session_id": "saml_sess_abc123",
      "api_key_id": "key_svc_01",
      "service_account_name": "integration-prod"
    },
    "organization_id": "org_example_001",
    "source_ip": "10.14.2.55",
    "logged_at": "2026-02-19T14:23:01Z",
    "requester_reference": "CASE-2026-00412",
    "identifiers_queried": 2
  },
  "completed_at": "2026-02-19T14:23:04Z",
  "result": {
    "data": {},
    "confidence": 0.84,
    "coverage_note": "One or more connectors were unavailable. Results may be incomplete."
  },
  "error": {
    "code": "analysis_failed",
    "message": "Insufficient graph data to complete analysis."
  }
}

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.

Body

application/json
​
subject
object
required

The entity or set of entities the analysis runs against.

​
analysis_type
string
required

The analysis to run. Use GET /analysis/types to discover what is available in this deployment. This field is an open string; new types are added by Intrace without requiring a contract change.

​
parameters
object

Type-specific parameters. The accepted parameters for each analysis type are documented at GET /analysis/types/{type}. Unknown parameters are ignored. All parameters are optional unless noted in the type's schema.

​
options
object

Response

Analysis completed.

​
analysis_id
string
required

Unique identifier for this analysis. Use it to retrieve the result later.

Example:

"ana_01JNQBC4X8Y2Z3D"

​
analysis_type
string
required

The analysis type that was run.

​
status
enum<string>
required
  • complete: analysis ran successfully. result is populated.
  • failed: analysis could not complete. error is populated.
Available options:
complete,
failed
​
subject
object
required

The entity or set of entities the analysis runs against.

​
queried_at
string<date-time>
required
Example:

"2026-02-19T14:23:00Z"

​
audit
object
required
​
completed_at
string<date-time> | null
Example:

"2026-02-19T14:23:04Z"

​
result
object

The result envelope for a completed analysis. The data field contains the type-specific output. Its structure is documented per analysis type at GET /analysis/types/{type} and may evolve independently of this contract.

​
error
object

Present when status is failed.