provider Subuser Statistics GET
/subusers/stats @utdk/sendgrid
/subusers/stats Retrieve email statistics for your subusers.
**This endpoint allows you to retrieve the email statistics for the given subusers.**
You may retrieve statistics for up to 10 different subusers by including an additional _subusers_ parameter for each additional subuser.
- limit query
- Limits the number of results returned per page.
- integer
- offset query
- The point in the list to begin retrieving results from.
- integer
- aggregated_by query
- How to group the statistics. Must be either "day", "week", or "month".
- enum: day, week, month
- subusers query required
- The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.
- string
- start_date query required
- The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
- string
- end_date query
- The end date of the statistics to retrieve. Defaults to today.
- string
Try it
Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import sendgrid from '@utdk/sendgrid';
await sendgrid.getSubusersStats()