Documentation
Projects and access
2. Projects
A project is an isolated analytics workspace with its own data, model, dashboards and users.
| Method | Path | Description |
|---|---|---|
| GET | /projects | List projects you have access to |
| POST | /projects | Create a project |
| GET | /projects/{project} | Project details, limits and links to all project resources |
| PUT | /projects/{project} | Update project properties |
| DELETE | /projects/{project} | Delete the project (Admin) |
List projects
HTTP
GET /api/v1/projects Accept: application/json Authorization: Bearer <token>
JSON
{
"projects": {
"sales_x1y2z3": {
"id": "sales_x1y2z3",
"label": "Sales Analytics",
"hasAccess": true,
"isAdmin": false,
"isMdAdmin": true,
"href": "/app/sales_x1y2z3"
}
}
}Create a project
HTTP
POST /api/v1/projects
Content-Type: application/json
{ "id": "sales", "label": "Sales Analytics", "entity": "<organization-id>", "desc": "Regional sales" }The server derives the final project id from id by adding a unique suffix. It is returned in the response. The caller must be an administrator of the organization (entity).
Other project resources
| Method | Path | Description |
|---|---|---|
| GET | /projects/{project}/limitadherence | Current usage vs. plan limits: { "<limit>": { "limit": n, "value": n } } |
| GET | /projects/{project}/activity?types=data_load,flow_run,obj_action | Recent project events (audit log). Types: data_load, flow_run, flow_trigger, obj_action, obj_share, project_action, user_action |
| GET | /projects/{project}/activity/loads?latest=1 | Latest data loads per dataset |
| GET / PUT | /projects/{project}/announce | Project-wide announcement { title, message, startDate, endDate } (PUT: Admin / User Admin) |
| GET | /projects/{project}/genid | Generate a unique Inzata id |
3. Users and access
| Method | Path | Description |
|---|---|---|
| GET | /projects/{project}/users | List project users |
| POST | /projects/{project}/users | Invite one or more users (body: an object or an array) |
| GET | /projects/{project}/users/{userId} | User's rights and roles |
| PUT | /projects/{project}/users/{userId} | Change rights; "active": false revokes access |
| DELETE | /projects/{project}/users/{userId} | Remove the user from the project |
Requires Admin or User Admin. A User Admin cannot grant rights higher than their own.
Invite a user
HTTP
POST /api/v1/projects/{project}/users
Content-Type: application/json
{
"id": "[email protected]",
"active": true,
"mdadmin": false,
"roles": ["sales_team"],
"sendemail": true
}| Field | Type | Description |
|---|---|---|
id | string, required | User email |
active | bool | Grants access to the project |
admin, mdadmin | bool | Permission levels |
roles | string[] | User roles, which control object visibility |
filter | string | Row-level data filter applied to everything the user sees |
sendemail | bool | Send an invitation email |
Further reading
Was this helpful?
Contact support