topic Re: Filter API Request by timestamp in APIs & Integrations

Filter API Request by timestamp

HOrdonez — Thu, 21 Oct 2021 09:15:19 GMT

Dear all,

I would like to ask if there is any way to add a timestamp (or date) in order to filter the results for an API request.

What I have beeen doing for now is getting all the data and filter by myself later on, but this solution is not scalable and I don't want to collapse the API limit.

For example, if I want to get feedback submissions (in python), right now I'm doing:

client.crm.objects.feedback_submissions.basic_api.get_page()

Is there any way to add a time range, a `from` or a `to` in the request?

I would like to ask if there is any way to get the list of properties that I can add to the request.

Thank you in advance.

Re: Filter API Request by timestamp

dennisedson — Fri, 22 Oct 2021 14:51:26 GMT

@HOrdonez ,

You should explore the search endpoints. You can use a filter group with a from and to range

Re: Filter API Request by timestamp

HOrdonez — Tue, 26 Oct 2021 12:28:28 GMT

Thank you for your answer @dennisedson . I cannot find which Object Type is associated with feedback_submissions or if it's available the search option for it.

Re: Filter API Request by timestamp

dennisedson — Wed, 27 Oct 2021 18:11:52 GMT

@HOrdonez

Feedback submissions is an Object.

You can see details on the endpoints, including search here

Re: Filter API Request by timestamp

HOrdonez — Thu, 28 Oct 2021 14:16:35 GMT

Thank you @dennisedson. I see that Feedback Submission has a search endpoint in the documentation that you sent, but is not in the other one.

The Python proposed implementation is not updated.

This is the one you provide:

client.crm.feedback_submissions.search_api.do_search(
public_object_search_request=public_object_search_request)

This is the one I think it should be:

client.crm.objects.feedback_submissions.search_api.do_search(
    public_object_search_request=public_object_search_request)

I would like to ask as well, if I want to filter the feedback submitted after yesterday using `hs_lastmodifieddate`, I declare the following object:

public_object_search_request = 
PublicObjectSearchRequest(filter_groups=[{"filters":[{"value":"2021-10-27",
"propertyName":"hs_lastmodifieddate","operator":"GT"}]}],
 properties=["hs_lastmodifieddate"], limit=0, after=0)

But I'm getting that exception, so I may be doing something wrong:

hubspot.crm.objects.feedback_submissions.exceptions.ApiException: (400)
Reason: Bad Request
HTTP response headers: HTTPHeaderDict({'Date': 'Thu, 28 Oct 2021 13:14:26 GMT', 'Content-Type': 'application/json;charset=utf-8', 'Content-Length': '123', 'Connection': 'keep-alive', 'CF-Ray': 'X', 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains; preload', 'Vary': 'Accept-Encoding', 'CF-Cache-Status': 'DYNAMIC', 'Access-Control-Allow-Credentials': 'false', 'Expect-CT': 'max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"', 'X-HubSpot-Correlation-Id': 'X', 'X-HubSpot-RateLimit-Daily': '500000', 'X-HubSpot-RateLimit-Daily-Remaining': 'X', 'X-Trace': 'X', 'Report-To': '{"endpoints":[{"url":"x"}],"group":"cf-nel","max_age":604800}', 'NEL': '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}', 'Server': 'cloudflare', 'alt-svc': 'h3=":443"; ma=86400, h3-29=":443"; ma=86400, h3-28=":443"; ma=86400, h3-27=":443"; ma=86400'})
HTTP response body: {"status":"error","message":"There was a problem with the request.","correlationId":"x"}

Re: Filter API Request by timestamp

dennisedson — Thu, 28 Oct 2021 14:47:57 GMT

@HOrdonez .

I will check with the team on why this object is not in the search documentation.

Why do you think that implementation is incorrect. It appears consistent with the other objects' python examples.

As for the error, try using a unix timestamp as your value.

Re: Filter API Request by timestamp

HOrdonez — Fri, 29 Oct 2021 19:01:50 GMT

@dennisedson The CRM Discovery object has not feedback_submission property, this one is inside object as I mentioned.

If I change the timestamp to unix timestamp, the API call doesn't have a Bad Request, but it returns nothing. Even using unix_timestamp as 10, the response is empty.

public_object_search_request = 
PublicObjectSearchRequest(filter_groups=[{"filters":[{"value":"10",
"propertyName":"hs_lastmodifieddate","operator":"GT"}]}],
 properties=["hs_lastmodifieddate"], limit=0, after=0)

Thank you for your help.

Re: Filter API Request by timestamp

HOrdonez — Tue, 02 Nov 2021 14:25:29 GMT

Hi @dennisedson , any update?

Re: Filter API Request by timestamp

dennisedson — Thu, 04 Nov 2021 13:37:56 GMT

@HOrdonez , make sure you are using milliseconds for the unix timestamp.

I tested with this request successfully:

{ "filterGroups": [ { "filters": [ { "value": "1635032689886", "propertyName": "hs_lastmodifieddate", "operator": "GT" } ] } ] }

Re: Filter API Request by timestamp

HOrdonez — Mon, 15 Nov 2021 09:52:10 GMT

@dennisedson thank you for your answer, it worked.

I would like to ask if it's possible to get the properties of Feedback from some API.

Even Feedback is an Object type in Hubspot. This doesn't work.

client.crm.properties.core_api.get_all(object_type='FEEDBACK',
                                        archived=False)

Re: Filter API Request by timestamp

dennisedson — Tue, 16 Nov 2021 15:49:40 GMT

@HOrdonez , you should be able to hit the properties endpoint

https://api.hubapi.com/crm/v3/properties/feedback_submissions