APIs & Integrations

patrickvention
Member

Engagements API to get list of open tasks, number of emails/calls in last 30-60 days

SOLVE

Hello all,

I'm new to this forum and excited to join the community!
I'm trying to use the 'All Engagements' API to assess the team productivity on a monthly basis, including number of calls made per day/week/month, number of emails, as well as number of tasks open vs completed.
When using the 'All engagements', the response is paged and starts from the beginning of time.

Is there a way to call this API with parameters (e.g., assigned to X user, created by X user, tasks = open, ...)? Alternatively, is there a way to have the API start from the most recent results and walk back from there?

Please help! Thanks you.

0 Upvotes
1 Accepted solution
IsaacTakushi
Solution
HubSpot Employee
HubSpot Employee

Engagements API to get list of open tasks, number of emails/calls in last 30-60 days

SOLVE

Welcome, @patrickvention!

Happy to help.

If that's your use case, the Get recent engagements endpoint may be a better fit! There are some limitations, however:

  • Neither endpoint allows query string filtering in the request URL. You will have to parse the JSON results by, for example, the ownerIds, which you can compare with the results from this endpoint to find productivity-by-rep.
  • As the documentation notes, the endpoint will only return records created in the last 30 days, or the 10K most recently created records. The 30 day time frame matches your use case, but if your reps collectively produce more than 10K engagements in a month, you may need to use the Get all engagements endpoint.

Isaac Takushi

Associate Certification Manager

View solution in original post

0 Upvotes
1 Reply 1
IsaacTakushi
Solution
HubSpot Employee
HubSpot Employee

Engagements API to get list of open tasks, number of emails/calls in last 30-60 days

SOLVE

Welcome, @patrickvention!

Happy to help.

If that's your use case, the Get recent engagements endpoint may be a better fit! There are some limitations, however:

  • Neither endpoint allows query string filtering in the request URL. You will have to parse the JSON results by, for example, the ownerIds, which you can compare with the results from this endpoint to find productivity-by-rep.
  • As the documentation notes, the endpoint will only return records created in the last 30 days, or the 10K most recently created records. The 30 day time frame matches your use case, but if your reps collectively produce more than 10K engagements in a month, you may need to use the Get all engagements endpoint.

Isaac Takushi

Associate Certification Manager
0 Upvotes