Searching engagements via metadata filter

Developer Support APIs & Integrations
1

Hi,

We wish to search all engagements and filter recordingUrl (under metadata) for a specific URL.

How should we go about this?

2

@arth, somehow, I feel like you might be able to help out here :grinning_face:

3

haha @dennisedson hi again :slightly_smiling_face:

@jamesgraham there is no way right now to search engagements, unfortunately.

I believe the only way to do this are to export all engagements via this GET endpoint Accounts Dashboard | HubSpot

and to search by the field “recordingUrl”.

Also, you can export just recent engagements Accounts Dashboard | HubSpot

4

To follow up on @arth 's point about it not being available to search now, we are working on making the engagements an object in an of itself which in theory could make it possible to use the search endpoint to filter. Keep your eyes open for developments on that :grinning_face:

5

@arththanks but that’s not an acceptable solution for us.

@dennisedsondo you know when this might be ready?

6

hi @jamesgraham seems Hubspot Dev Team did it!

I just checked and in my case it worked perfectly.

method: POST

endpoint - https://api.hubapi.com/crm/v3/objects/calls/search

body:

{
 "filterGroups": [
 {
 "filters": [
 {
 "propertyName": "hs_call_recording_url",
 "operator": "EQ",
 "value": "{{recording_url}}"
 }
 ]
 }
 ]
}

paste your link into recording_url and done.

if you need to extend returned properties, simply add after the filter an object with array of all the properties you need to get:

"properties": [ "email", "state" ]

the list of available properties for calls you may find following this link:

PS but don’t trust them - some properties that not listed in the documentation still might be returned, you just need conduct some research :grinning_face_with_smiling_eyes:

7

@jamesgraham , @arth

Yeah! We released the new engagements API documentation relatively recently!

Feast your eyes on this

PS but don’t trust them - some properties that not listed in the documentation still might be returned, you just need conduct some research :grinning_face_with_smiling_eyes:

I think @arth is saying “Trust but verify”

8

@dennisedson , you got me :sweat_smile:

I think @arth is saying “Trust but verify”

BTW, I’m in love with new search and association endpoints, you guys did a fantastic job!