topic Python API endpoint to get historical deal stages of deals in APIs & Integrations

Python API endpoint to get historical deal stages of deals

JohnWongCK — Fri, 05 May 2023 06:29:01 GMT

Hi,

I wanted to get the historical deal stages of deals.

For example:

1) Deal name = X --> Moved from stage A to B

Deal id = ...

Deal owner = ...

Deal created datetime = ...

* Deal stage = A --> Date moved = a

* Deal stage = B --> Date moved = b

2) Deal name = Y --> Moved from stage A to B to C

Deal id = ...

Deal owner = ...

Deal created datetime = ...

* Deal stage = A --> Date moved = a

* Deal stage = B --> Date moved = b

* Deal stage = C --> Date moved = c

I tried using this Python API endpoint from all the posts that I have read in the community:

* URL = 'https://api.hubapi.com/crm/v3/objects/deal?properties=hubspot_owner_id&properties=dealstage&properties=dealname&includePropertyVersions=true&limit=100'

* I am using "GET" request

However, I cannot get the historical deal stages of deals. I can only get their latest deal stages.

Look forward to your advice on how I can do so.

Thank you.

John

Re: Python API endpoint to get historical deal stages of deals

himanshurauthan — Fri, 05 May 2023 07:47:06 GMT

Hello @JohnWongCK

The API endpoint you are currently using only provides the latest deal stage of a deal. In order to get the historical deal stages, you will need to use a different endpoint and query parameter.

One option is to use the "timeline" endpoint to get a timeline of all the activities associated with the deal, including changes to the deal stage. Here's an example code snippet that demonstrates how to use this endpoint.

import requests deal_id = '123456789' # Replace with the ID of the deal you want to retrieve the historical stages for hapikey = 'your_api_key_here' # Replace with your HubSpot API key url = f'https://api.hubapi.com/engagements/v1/engagements/associated/deal/{deal_id}/paged?include=metadata&hapikey={hapikey}' response = requests.get(url) timeline = response.json() deal_stages = [] for item in timeline['results']: if item['metadata']['type'] == 'NOTE': note_text = item['metadata']['body'] if 'Deal stage changed from' in note_text: stage_change = note_text.split('Deal stage changed from ')[1].split(' to ') from_stage = stage_change[0] to_stage = stage_change[1].rstrip('.') timestamp = item['engagement']['createdAt'] deal_stages.append({'from_stage': from_stage, 'to_stage': to_stage, 'timestamp': timestamp}) print(deal_stages)

This code will retrieve all the activities associated with the specified deal and filter out the ones that represent changes to the deal stage. It will then extract the previous and current stages, as well as the timestamp of the stage change, and store them in a list of dictionaries.

Re: Python API endpoint to get historical deal stages of deals

JohnWongCK — Fri, 05 May 2023 09:19:32 GMT

Hi @himanshurauthan ,

Thank you very much for your advice.

So the process will be:

1) Get all deals

2) For each deal, input deal id into codes you have provided

3) Repeat (2) for all deals

Hope I got it correct.

Thank you once again.

John