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"  
      }  
    ]  
  }

Full documentation of the endpoint below:

200Successfully retrieved usage metrics

400Invalid request parameters

401Missing or invalid bearer token

403Unauthorized - token is valid but lacks permission

500Internal server error

503Service temporarily unavailable