Get team usage metrics

GET https://app.eraser.io/api/reports/usage

This endpoint retrieves team usage metrics including aggregate statistics and individual member activity for a specified date range.

This endpoint is only available to customer on the Enterprise Plan.

An example cURL request is:

  curl --location 'https://app.eraser.io/api/reports/usage?rangeDays=30'  
  --header 'Authorization: Bearer $YOUR-TOKEN-HERE'

rangeDaysspecifies the range of the report and defaults to 30 days.

endDate specifies the ending date of the date range in YYYY-MM-DD format and defaults to the current date.

Note that you don't need to explicitly specify a team on your request since your API token is specific to a team.

An example response is:

  {  
    "range": {  
      "start": "2025-07-01",  
      "end": "2025-07-31"  
    },  
    "aggregate": {  
      "teamName": "Enterprise architecture",  
      "totalMembers": 60,  
      "activeMembers": 50,  
      "inactiveMembers": 10,  
      "totalFiles": 100,  
      "totalFilesCreated": 34,  
      "totalFilesViewed": 43,  
      "totalFileViews": 1234,  
      "totalAiCreditsUsed": 789  
    },  
    "members": [  
      {  
        "email": "alice@example.com",  
        "displayName": "Alice Walker",  
        "filesCreated": 5,  
        "filesViewed": 7,  
        "fileViews": 12,  
        "aiCreditsUsed": 100,  
        "lastActive": "2025-07-30T15:45:00Z"  
      },  
      {  
        "email": "bob@example.com",  
        "displayName": "Bob Doe",  
        "filesCreated": 0,  
        "filesViewed": 7,  
        "fileViews": 12,  
        "aiCreditsUsed": 0,  
        "lastActive": "2025-07-10T09:12:00Z"  
      }  
    ]  
  }

Query parameters

rangeDays integer query

Number of days to include in the report

endDate string query

End date for the report range (YYYY-MM-DD format)

Responses

200 – Successfully retrieved usage metrics

range object required2 fields

Date range for the usage report

start string required

Start date of the reporting period

end string required

End date of the reporting period

aggregate object required9 fields

Aggregated team-level usage metrics

teamName string required

Name of the team

totalMembers integer required

Total number of team members (doest not include guests)

activeMembers integer required

Number of members with activity (at least 1 fiew view) in the period

inactiveMembers integer required

Number of members without activity (no file views) in the period

totalFiles integer required

Total number of files owned by the team

totalFilesCreated integer required

Number of files created during the period

totalFilesViewed integer required

Number of unique files viewed during the period

totalFileViews integer required

Total number of file view events during the period

totalAiCreditsUsed integer required

Total AI credits consumed during the period

members object[] required7 fields

Individual member usage metrics

email string required

Member's email address

displayName string required

Member's display name

filesCreated integer required

Number of files created by this member

filesViewed integer required

Number of unique files viewed by this member

fileViews integer required

Total file view events by this member

aiCreditsUsed integer required

AI credits consumed by this member

lastActive string required

Last time the user logged a file view event

200 response

{
  "range": {
    "start": "2025-07-01",
    "end": "2025-07-31"
  },
  "aggregate": {
    "teamName": "Enterprise architecture",
    "totalMembers": 60,
    "activeMembers": 50,
    "inactiveMembers": 10,
    "totalFiles": 100,
    "totalFilesCreated": 34,
    "totalFilesViewed": 43,
    "totalFileViews": 1234,
    "totalAiCreditsUsed": 789
  },
  "members": [
    {
      "email": "alice@example.com",
      "displayName": "Alice Walker",
      "filesCreated": 5,
      "filesViewed": 7,
      "fileViews": 12,
      "aiCreditsUsed": 100,
      "lastActive": "2025-07-30T15:45:00Z"
    }
  ]
}

400 – Invalid request parameters

error string

Error message describing the validation issue

400 response

{
  "error": "string"
}

401 – Missing or invalid bearer token

error string

Authentication error message

401 response

{
  "error": "string"
}

403 – Unauthorized - token is valid but lacks permission

error string

Authorization error message

403 response

{
  "error": "string"
}

500 – Internal server error

error string

Error message describing the server issue

500 response

{
  "error": "string"
}

503 – Service temporarily unavailable

error string

Service availability error message

503 response

{
  "error": "string"
}