List overview for a project

GET

/v1/projects/{projectId}/overview

curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/overview' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired

Responses

Success

dataobjectrequired
- projectobjectrequired
- metricsobjectrequired
- capabilitiesobjectrequired
- permissionsarray<string>required
- currentMembershipobject | nullrequired

Response example

{
  "data": {
    "project": {
      "id": "string",
      "tenantId": "string",
      "slug": "string",
      "name": "string",
      "description": "string",
      "dataFormat": "string",
      "projectType": "string",
      "projectSubtype": "string",
      "visibility": "string",
      "status": "string",
      "isSample": false,
      "lastAccessedAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    },
    "metrics": {
      "datasetCount": 0,
      "fileCount": 0,
      "storageBytes": 0,
      "lastUploadAt": "string",
      "qualityIssueCount": 0
    },
    "capabilities": {
      "canViewProject": false,
      "canViewDatasets": false,
      "canViewProcessing": false,
      "canUploadData": false,
      "canSubmitUploadBatch": false,
      "canRunProcessing": false,
      "canViewAnalytics": false,
      "canEditProcessingTemplates": false,
      "canPublishProcessingTemplates": false,
      "canRollbackProcessingTemplates": false,
      "canSetDefaultProcessingTemplate": false,
      "canEditProjectSettings": false,
      "canManageMembers": false,
      "canArchiveProject": false,
      "canDeleteProject": false
    },
    "permissions": "project:read",
    "currentMembership": {
      "membershipId": "string",
      "roles": "owner",
      "roleSources": [
        "string"
      ]
    }
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

{ "data": { "project": { "id": "string", "tenantId": "string", "slug": "string", "name": "string", "description": "string", "dataFormat": "string", "projectType": "string", "projectSubtype": "string", "visibility": "string", "status": "string", "isSample": false, "lastAccessedAt": "string", "createdAt": "string", "updatedAt": "string" }, "metrics": { "datasetCount": 0, "fileCount": 0, "storageBytes": 0, "lastUploadAt": "string", "qualityIssueCount": 0 }, "capabilities": { "canViewProject": false, "canViewDatasets": false, "canViewProcessing": false, "canUploadData": false, "canSubmitUploadBatch": false, "canRunProcessing": false, "canViewAnalytics": false, "canEditProcessingTemplates": false, "canPublishProcessingTemplates": false, "canRollbackProcessingTemplates": false, "canSetDefaultProcessingTemplate": false, "canEditProjectSettings": false, "canManageMembers": false, "canArchiveProject": false, "canDeleteProject": false }, "permissions": "project:read", "currentMembership": { "membershipId": "string", "roles": "owner", "roleSources": [ "string" ] } } }