GET
/
contacts
/
search
/
v1
/
external
/
lifecyclestages
Get Lifecycle Stage metrics for Contacts
curl --request GET \
  --url https://api.hubapi.com/contacts/search/v1/external/lifecyclestages
"\nExample GET URL (without additional aggregation):\nhttps://api.hubapi.com/contacts/search/v1/external/lifecyclestages?fromTimestamp=1514764800000&toTimestamp=1519862400000\n\nExample response:\n[\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_lead_date\",\n    \"count\": 34657\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_opportunity_date\",\n    \"count\": 1\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_marketingqualifiedlead_date\",\n    \"count\": 3\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_salesqualifiedlead_date\",\n    \"count\": 0\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_evangelist_date\",\n    \"count\": 0\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_customer_date\",\n    \"count\": 242\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_subscriber_date\",\n    \"count\": 39\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_other_date\",\n    \"count\": 0\n  }\n]\n\n\nExample with aggregation using hs_analytics_source:\nhttps://api.hubapi.com/contacts/search/v1/external/lifecyclestages?fromTimestamp=1514764800000&toTimestamp=1519862400000&aggregationProperty=hs_analytics_source\n\nExample response:\n[\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_lead_date\",\n    \"count\": 34657,\n    \"aggregation\": {\n      \"count\": 34657,\n      \"aggregations\": {\n        \"hs_analytics_source\": [\n          {\n            \"key\": \"DIRECT_TRAFFIC\",\n            \"count\": 30794\n          },\n          {\n            \"key\": \"OFFLINE\",\n            \"count\": 3822\n          },\n          {\n            \"key\": \"PAID_SOCIAL\",\n            \"count\": 18\n          }\n        ]\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_opportunity_date\",\n    \"count\": 1,\n    \"aggregation\": {\n      \"count\": 1,\n      \"aggregations\": {\n        \"hs_analytics_source\": [\n          {\n            \"key\": \"OFFLINE\",\n            \"count\": 1\n          }\n        ]\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_marketingqualifiedlead_date\",\n    \"count\": 3,\n    \"aggregation\": {\n      \"count\": 3,\n      \"aggregations\": {\n        \"hs_analytics_source\": [\n          {\n            \"key\": \"DIRECT_TRAFFIC\",\n            \"count\": 2\n          },\n          {\n            \"key\": \"OFFLINE\",\n            \"count\": 1\n          }\n        ]\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_salesqualifiedlead_date\",\n    \"count\": 0,\n    \"aggregation\": {\n      \"count\": 0,\n      \"aggregations\": {\n        \"hs_analytics_source\": []\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_evangelist_date\",\n    \"count\": 0,\n    \"aggregation\": {\n      \"count\": 0,\n      \"aggregations\": {\n        \"hs_analytics_source\": []\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_customer_date\",\n    \"count\": 242,\n    \"aggregation\": {\n      \"count\": 242,\n      \"aggregations\": {\n        \"hs_analytics_source\": [\n          {\n            \"key\": \"OFFLINE\",\n            \"count\": 169\n          },\n          {\n            \"key\": \"DIRECT_TRAFFIC\",\n            \"count\": 73\n          }\n        ]\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_subscriber_date\",\n    \"count\": 39,\n    \"aggregation\": {\n      \"count\": 39,\n      \"aggregations\": {\n        \"hs_analytics_source\": [\n          {\n            \"key\": \"DIRECT_TRAFFIC\",\n            \"count\": 26\n          },\n          {\n            \"key\": \"OFFLINE\",\n            \"count\": 13\n          }\n        ]\n      }\n    }\n  },\n  {\n    \"lifecycleStage\": \"hs_lifecyclestage_other_date\",\n    \"count\": 0,\n    \"aggregation\": {\n      \"count\": 0,\n      \"aggregations\": {\n        \"hs_analytics_source\": []\n      }\n    }\n  }\n]"

Query Parameters

​
includeTotalContacts
string

A boolean to determine if the number of total contacts should be included in the response.

​
includeLastNewContactAt
string

A boolean to determine if the time stamp of the last contact created should be included in the response.

Response

200 - application/json

Successful response - Returns the total number of contacts in the account and the date of the last contact add

The response is of type object.