Reports›User Note Activity Report

User Note Activity Report

Returns how many notes each user added, by note category. It’s the API version of the User Note Activity report in Shape.

POSThttps://secure-api.setshape.com/api/reports/user-notes-tracking/{crmid}

Replace {crmid} with your CRM ID, the Shape system ID that belongs to your API key. Send the standard headers on every request: Authorization: YOUR_API_AUTHORIZATION_KEY and Content-Type: application/json. See Authentication.

This report returns data for the system your API key belongs to. Use the CRM ID and API key for the same system.

Dates are optional; without them, the report covers the current month to date. This report isn’t paged. See Reports Overview.

Body parameters

Send a filters object holding the report’s filters.

Field Requirement Description
filters Required An object holding the report’s filters.
fromDate Optional Start date, YYYY-MM-DD.
toDate Optional End date, YYYY-MM-DD.
drpUsers Optional Limit the report to certain users.
countType Optional What to count. Defaults to leads.
includeDeletedLeads Optional Whether to include deleted records.

Example request

{
  "filters": {
    "fromDate": "2026-08-01",
    "toDate": "2026-08-08"
  }
}

Response

Each row has a user key plus one key per note category: the category name in lowercase, with underscores for spaces (Follow Up becomes follow_up). Keys differ between systems. The report covers up to 15 note categories.

Users are sorted by total notes, most first. The last row has "user": "Total".

{
  "status": 1,
  "msg": "Success",
  "data": [
    { "user": "Alex Example", "general": 12, "follow_up": 4 },
    { "user": "Jordan Sample", "general": 3, "follow_up": 0 },
    { "user": "Total", "general": 15, "follow_up": 4 }
  ]
}