/doc/openapi

Developing

GET/doc/openapi

Last modified: a year ago

If requested with parameters, updates the onboarding status of the user.
Always returns the current onboarding state.

Request

Query Params

main_intro

string

optional

Flag. Example: true/false.

alerts_intro

string

optional

Flag. Example: true/false.

alerts_from_search

string

optional

Flag. Example: true/false.

training_intro

string

optional

Flag. Example: true/false.

Request samples

Responses

An example Response(200)

An example Response

HTTP Code: 200

Content Type : JSONapplication/json

object {0}

{
  "status": {
    "created_timestamp": 1657032208,
    "created_string": "Tue 05 Jul 2022 @ 14:43 (UTC)",
    "duration": 0.215,
    "language": "en-gb",
    "timezone": {
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "code": 200,
    "oldest_cached_component_age": 1182,
    "session_id": "659e8c297cb040430a660b284a50bd21",
    "org_onboarding_status_id": 300,
    "api_host": "api-stage.anomify.ai",
    "user_onboarding_flags": {
      "main_intro": true,
      "alerts_intro": true,
      "alerts_from_search": true,
      "training_intro": false,
      "alert_created": true,
      "test_alert_sent": true,
      "two_alerts_sent": true,
      "pattern_trained": true
    }
  },
  "data": {
    "message": "OK",
    "onboarding_flags": {
      "main_intro": false,
      "alerts_intro": false,
      "alerts_from_search": false,
      "training_intro": false,
      "alert_created": true,
      "test_alert_sent": true,
      "two_alerts_sent": true,
      "pattern_trained": true
    }
  }
}

Last modified: a year ago