Organization API: Org Staff Insight
Every Organization API operation tagged Org Staff Insight.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Organization API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/staff/activity |
The org's audit log |
| GET | /api/v1/orgs/{org_slug}/staff/activity/actions |
The action names that have occurred, for the filter |
| GET | /api/v1/orgs/{org_slug}/staff/insights |
Money, orders, customers and support over the window, by day |
| GET | /api/v1/orgs/{org_slug}/staff/insights/export.csv |
The daily series as one CSV: a column per measure, a row per day |
The org's audit log
Section titled The org's audit logGET /api/v1/orgs/{org_slug}/staff/activity
The org's audit log. Admins read all of it. Tier 3 and billing must name the customer, order or server they are looking at, or ask for their own actions, which is all Tiers 1 and 2 may see.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
customer_id |
query | integer or null | no | |
service_id |
query | integer or null | no | |
server_uuid |
query | string or null | no | |
actor_id |
query | integer or null | no | |
action |
query | string or null | no | |
resource_type |
query | string or null | no | |
since |
query | string (date) or null | no | |
until |
query | string (date) or null | no | |
q |
query | string or null | no | |
limit |
query | integer | no | Default: 50. |
offset |
query | integer | no | Default: 0. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
The action names that have occurred, for the filter
Section titled The action names that have occurred, for the filterGET /api/v1/orgs/{org_slug}/staff/activity/actions
The action names that have occurred, for the filter. Below Tier 3, only the ones the caller took.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Money, orders, customers and support over the window, by day
Section titled Money, orders, customers and support over the window, by dayGET /api/v1/orgs/{org_slug}/staff/insights
Money, orders, customers and support over the window, by day.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
days |
query | integer | no | Default: 30. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
The daily series as one CSV: a column per measure, a row per day
Section titled The daily series as one CSV: a column per measure, a row per dayGET /api/v1/orgs/{org_slug}/staff/insights/export.csv
The daily series as one CSV: a column per measure, a row per day.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
days |
query | integer | no | Default: 30. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |