/progress/{progress_id}/update

Update progress

Request

Path Params

key

string

required

Query Params

secret

string

required

state

string

optional

Example:

completed

seconds_remaining

integer

optional

Number of seconds remaining to complete the task.

Example:

proportion_completed

number

optional

Proportion of the task completed, between 0 and 1 inclusive.

Example:

0.5

message

string

optional

A string to present to the end user. This can be set multiple times to provide updates.

Example:

This might take a while.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200An example Response

application/json

Body

object {0}

Example

{
  "status": {
    "created_timestamp": 1657641259,
    "created_string": "Tue 12 Jul 2022 @ 15:54 (UTC)",
    "duration": 0.279,
    "language": "en-gb",
    "timezone": {
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "code": 200,
    "oldest_cached_component_age": 607,
    "session_id": "103bfbd9f2cdd43fe809104eefc713f7",
    "org_onboarding_status_id": 300,
    "api_host": "api-stage.anomify.ai",
    "user_onboarding_flags": {
      "main_intro": true,
      "alerts_intro": false,
      "alerts_from_search": false,
      "training_intro": false,
      "alert_created": true,
      "test_alert_sent": true,
      "two_alerts_sent": true,
      "pattern_trained": true
    }
  },
  "data": {
    "users": [
      {
        "id": 101,
        "org_id": 101,
        "name": "Phil Collins",
        "email": "si@anomalarm.io",
        "phone_number": "+447976123456",
        "slack_member_id": "U04UFSKFY",
        "demo": false,
        "admin": true,
        "org": {
          "id": 101,
          "name": "Anomify",
          "timezone": "UTC",
          "alert_muting": {
            "muted": false,
            "muted_until_timestamp": null,
            "muted_until_timestamp_string": null,
            "minutes_remaining": null
          },
          "onboarding_status_id": 300,
          "connected_services": {
            "slack": true,
            "ms_teams": false
          }
        },
        "notifications": {
          "email_alerts": true
        },
        "onboarding_flags": {
          "main_intro": true,
          "alerts_intro": false,
          "alerts_from_search": false,
          "training_intro": false,
          "alert_created": true,
          "test_alert_sent": true,
          "two_alerts_sent": true,
          "pattern_trained": true
        }
      },
      {
        "id": 102,
        "org_id": 101,
        "name": "Will Floutier",
        "email": "will@anomalarm.io",
        "phone_number": null,
        "slack_member_id": null,
        "demo": false,
        "admin": true,
        "org": {
          "id": 101,
          "name": "Anomify",
          "timezone": "UTC",
          "alert_muting": {
            "muted": false,
            "muted_until_timestamp": null,
            "muted_until_timestamp_string": null,
            "minutes_remaining": null
          },
          "onboarding_status_id": 300,
          "connected_services": {
            "slack": true,
            "ms_teams": false
          }
        },
        "notifications": {
          "email_alerts": true
        },
        "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
        }
      }
    ]
  }
}