Get Environment Activity Data

GET 
/api/statistics/

Returns the environment activity data as grouped by statistics scope (users, developers or workspaces). On successful response you will see the subset of the response structure based on the scope (users, developers or workspaces).

Request

Query Parameters

stats_type stringrequired

Possible values: [users, developers, workspaces]

Choose 'users', 'developers' or 'workspaces'.

start date-timerequired

Start date of date range.

end date-timerequired

End date of date range.

org_domain string

Possible values: non-empty

Specify a specific Organization domain.

Responses

200

application/json

Schema

Schema

developers

object

required

total_developers

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

day integerrequired

Possible values: >= 1

Day of the month.

]

monthly_active_developers

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

]

daily_active_developers

object

required

per_day

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

day integerrequired

Possible values: >= 1

Day of the month.

]

per_week

object[]

required

Array [

year integerrequired

Year value.

count integerrequired

Count value.

week integerrequired

Possible values: >= 1

Week of the year.

]

per_month

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

]

users

object

required

total_users

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

day integerrequired

Possible values: >= 1

Day of the month.

]

monthly_active_users

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

]

daily_active_users

object

required

per_day

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

day integerrequired

Possible values: >= 1

Day of the month.

]

per_week

object[]

required

Array [

year integerrequired

Year value.

count integerrequired

Count value.

week integerrequired

Possible values: >= 1

Week of the year.

]

per_month

object[]

required

Array [

year integerrequired

Year value.

month integerrequired

Possible values: >= 1 and <= 12

Month number of the year.

count integerrequired

Count value.

]

workspaces

object

required

total_users objectrequired

Total users in dynamic response with structure of

[{"year": <year>, "month": <month>, "day": <day>, <workspace_id>: <count>...}]

monthly_active_users objectrequired

Monthly active users in dynamic response with structure of

[{"year": <year>, "month": <month>, <workspace_id>: <count>...}]

daily_active_users objectrequired

Daily active users in dynamic response with structure of

{"per_month": [{"year": <year>, "month": <month>, <workspace_id>: <count>...}]}

Example (from schema)

{
  "developers": {
    "total_developers": [
      {
        "year": 0,
        "month": 0,
        "count": 0,
        "day": 0
      }
    ],
    "monthly_active_developers": [
      {
        "year": 0,
        "month": 0,
        "count": 0
      }
    ],
    "daily_active_developers": {
      "per_day": [
        {
          "year": 0,
          "month": 0,
          "count": 0,
          "day": 0
        }
      ],
      "per_week": [
        {
          "year": 0,
          "count": 0,
          "week": 0
        }
      ],
      "per_month": [
        {
          "year": 0,
          "month": 0,
          "count": 0
        }
      ]
    }
  },
  "users": {
    "total_users": [
      {
        "year": 0,
        "month": 0,
        "count": 0,
        "day": 0
      }
    ],
    "monthly_active_users": [
      {
        "year": 0,
        "month": 0,
        "count": 0
      }
    ],
    "daily_active_users": {
      "per_day": [
        {
          "year": 0,
          "month": 0,
          "count": 0,
          "day": 0
        }
      ],
      "per_week": [
        {
          "year": 0,
          "count": 0,
          "week": 0
        }
      ],
      "per_month": [
        {
          "year": 0,
          "month": 0,
          "count": 0
        }
      ]
    }
  },
  "workspaces": {
    "total_users": {},
    "monthly_active_users": {},
    "daily_active_users": {}
  }
}

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

(Is Not App AND Is Authenticated)

Descriptions:

Is Authenticated : Allows access only to authenticated users.

Is Not App : Client must not be a VIKTOR app.

Loading...