APIs & Integrations

jamesgraham
Member

Searching engagements via metadata filter

SOLVE

Hi,

 

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

 

How should we go about this?

0 Upvotes
2 Accepted solutions
arth
Solution
Contributor

Searching engagements via metadata filter

SOLVE

haha @dennisedson hi again 🙂

@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 https://legacydocs.hubspot.com/docs/methods/engagements/get-all-engagements

and to search by the field "recordingUrl".

Also, you can export just recent engagements https://legacydocs.hubspot.com/docs/methods/engagements/get-recent-engagements

View solution in original post

arth
Solution
Contributor

Searching engagements via metadata filter

SOLVE

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:

https://developers.hubspot.com/docs/api/crm/calls

 

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

View solution in original post

7 Replies 7
arth
Solution
Contributor

Searching engagements via metadata filter

SOLVE

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:

https://developers.hubspot.com/docs/api/crm/calls

 

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

dennisedson
HubSpot Product Team
HubSpot Product Team

Searching engagements via metadata filter

SOLVE

@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 😄

I think @arth is saying "Trust but verify"

 

0 Upvotes
arth
Contributor

Searching engagements via metadata filter

SOLVE

@dennisedson , you got me 😅


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!

dennisedson
HubSpot Product Team
HubSpot Product Team

Searching engagements via metadata filter

SOLVE

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

arth
Solution
Contributor

Searching engagements via metadata filter

SOLVE

haha @dennisedson hi again 🙂

@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 https://legacydocs.hubspot.com/docs/methods/engagements/get-all-engagements

and to search by the field "recordingUrl".

Also, you can export just recent engagements https://legacydocs.hubspot.com/docs/methods/engagements/get-recent-engagements

dennisedson
HubSpot Product Team
HubSpot Product Team

Searching engagements via metadata filter

SOLVE

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 😀

0 Upvotes
jamesgraham
Member

Searching engagements via metadata filter

SOLVE

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

@dennisedsondo you know when this might be ready?

0 Upvotes