You want to see the traffic and leads tracked in HubSpot next to the sales activity and deal progression from your CRM to get a fuller sense of your business performance. For instance, in the case where we generate both a SENT event and a subsequent DROPPED event, the SENT event is ultimately irrelevant, and is obsoleted by the DROPPED event. An ID attached to the message by HubSpot. "freezeDate": 1553518847225, If not applicable, this property is omitted. "mailingListsIncluded": [ Use this function to track aneventusing JavaScript and HubSpot's tracking code. "created": 1522850740250, 
To get details for sales emails you can use the Engagements API.
the visitor was previously identified by ID and also has a form submission associated with their record. This backward-reference can be useful to get more information on the parent SENT event, or to manually find all events associated with a given message. Whether this is provided, and what its value is, is determined by the recipient's email client. A contact can only have one ID and/or email address associated with them. An ID referencing the HubSpot account that sent the email message. "emailbodyPlaintext": "", This will correspond to your account. Once this happens, you'll need manual intervention by HubSpot to remove the flag. "emailNote": "",
Many events are related to other events that occurred either before or after it. The message originated from a suspicious (or previously unknown) IP address. Discover APIs, integration guides, and other documentation. You must include an email address to tie the data to a contact. Thev3Emails Events API is currently under development. ], "rssEmailClickThroughText": "Read more ", You can use events to track specific activities completed by visitors on your site. Occasionally, things don't go smoothly, and one of two things happens: delivery is deferred because of a temporary rejection, or delivery fails and won't be retried. Defaults to 10, Used to get the next page of results. Note: Only accounts with an Enterprisesubscription will be able to access the Analytics API using an API key. The message was not sent, the recipient has been unengaged with previous marketing emails. "analyticsPageId": "5681632705", This page has been updated for working with new custom behavioral events. Please review your SPF and DMARC policies. Each JSON subscription object is comprised of the properties: A HubSpot employee explicitly initiated the status change to block messages to the recipient. See below for the possible values. The sending domain has a poor reputation or a reputation that doesn't meet the standards of the recipient server. If you exceed those limits, you'll receive one of the following errors: Below you can see examples of responses you'd receive from the Analytics API. Note: We are currently in the process of updating our APIs to improve consistency and completeness. An email message may also be flagged as spam by the recipient, resulting in a SPAMREPORT event. You can also track non-defined properties and go back to create them after event tracking. Since this function works alongside HubSpot's analytics tracking, any events triggered through the JavaScript API will automatically be associated with the visitor's hubspotutk cookie, so the event would automatically be tied to the contact associated with that usertoken. The data returned by these APIs will mimic the data you would see in those tools. "domain": "", However, sometimes our delivery provider will decide to reject a message even after we have verified its eligibility. Is there anything we could change to make this article helpful? A message can be deferred multiple times before it completes the delivery phase, with a new event created on each attempt. Additional information on the email campaign can be found via, The EventId which uniquely identifies the email message's. For the full breakdown of the required plan for each feature, see the table below. "replyTo": "noreply@hubspot.com", 413 response code with RESULT_POINT_LIMIT_EXCEEDED - Returned when there are too many time data points. For example, each time any URL is clicked, a new CLICK event is created, even if that URL has previously been clicked and generated such an event. By default, HubSpot creates a set of properties for each event you create. Your account went over its monthly limit for email sends. An array of JSON objects representing the status of subscriptions for the recipient. This would include reapplying anyclicked element eventsthat have been set up. property_name is the internal name of the event property youve created for the event, and property_value is the value to add to the property. The message has been received by our delivery provider, which has indicated it will attempt to deliver the message to the recipient's email server. If delivery fails, no further attempts will be made to deliver the message, and we create a BOUNCE event. Thank you for your feedback, it means a lot to us. The path should always start with a slash. This ID cannot be used to retrieve or update any records through any other HubSpot tools or APIs. When using a, 501 response code withRESULT_LIMIT_EXCEEDED - Returned when there are too many breakdowns in the response. These include the same parameters returned from the 'get all marketing emails' and 'get a marketing email' endpoints, in addition to the performance related metrics described in the table below.
We make every effort to reject messages before passing them along to our delivery provider. They are broadly grouped into categories: Submission, Delivery, User Engagement, and User Status. The recipient's mailbox was full and couldn't receive any messages. The recipient's portal subscription status. When looking for which values you can use for drilling down, it's a good idea to start with the total summary (using total for the :time_period) and looking at the breakdowns in that summary data. "id": 5681632705, "abHoursToWait": 1, Please see the stats specific pages for a description of the email statistics fields. { "feedbackSurveyId": null, When an email message is created and sent by HubSpot on behalf of a customer, we first verify whether the recipient is eligible to receive it. A previous message to the recipient resulted in a bounce. Analytics data associated with the usertoken, such as page views and original source,will then appear on the contact record. Sometimes, a follow-on event occurs for a given message, signifying that an earlier event should be ignored. Please note: some event types, such as bot events, may be included in the response to the /events API but won't appear when you're analyzing the Recipients tab for a marketing email in your HubSpot account, which filters out certain raw event types and limits the total events shown to 30 events per event type. "feedbackEmailCategory": null, You can further customize these events with the, : events tied to page loads at specified URLs. The number of contacts that mark the email as spam over the total number of selected contacts. Subscribe to the Developer Changelog to get notified when it's available. The name of the HubSpot application that sent the email message. Learn how to find the internal name for an event. "abVariation": false, There are three types of events that you can create in HubSpot: For each event type, HubSpot includes a set of standard properties that can capture certain metadata at the time of completion, including UTM parameters or device and operating system metadata. The Analytics API allows you to export analytics and reporting data from HubSpot. You can still send to these people in the future. The v3 Reporting API is currently under development. The Analytics API is designed around the functionality of HubSpot's various reporting tools. The recipient used a list-unsubscribe header. The recipient flagged the message as spam. You can then send the identity to HubSpot by making a separate trackPageView or trackCustomBehavioralEvent call. User engagement events all share the following properties: A JSON object representing the location where the event occurred. ], How do I find the app ID for a HubSpot app? The status code returned from the recipient's email server. The receiving email server timed out and is no longer accepting email. The recipient changed their email subscriptions in some way. For example: In this article, learn about how you can add functions to the tracking code to identify visitors, track page views, send event data, and more. The domain is set automatically based on the URL of the page on load, and the path that is set using this function is always treated as relative to that detected domain. "customReplyTo": "", "rssEmailBlogImageMaxWidth": 0, Search the docs for APIs, endpoints or guides. Copies the contents of the auto-save buffer into the live template. Example data when pulling total stats or stats broken down by specific criteria: Example data when pulling data for a specific time period (in this case, daily): . This API can be used to programmatically create marketing emails, get details about marketing emails, and update marketing emails. A JSON object representing the browser which serviced the event. "abSamplingDefault": null, If provided and nonzero, the approximate number of milliseconds the user had opened the email. By clicking on the subscription preferences link in the message, they can change their subscriptions, either subscribing or unsubscribing from various lists, triggering a STATUSCHANGE event. For clicked element or visited URL events, HubSpot will auto-populate some of those properties with data. The number of contacts received your email and marked it as spam. You can use the setPathandtrackPageViewfunctions to update and track the current page. Using custom behavioral events, you can tie event completions to contacts records and populate event properties with metadata about the event. "analyticsPageType": "email", "limit": 2, "allEmailCampaignIds": [ For legacy custom events, please see the legacy documentation. The delivery provider will re-queue the message for later delivery, and we create a DEFERRED event. For more details about the page performance report, please see the article, , the first level drill down options (using the. Further, all but one event type (UNBOUNCE) have the following properties: Events can be looked up in bulk via this endpoint using 'recipient', both 'appId' and 'campaignId', or any combination of the above properties. to gather data and power a machine learning model that determines the best time to send emails to different contact segments. Starting November 30, 2022, API keys will be sunset as an authentication method. To get analytics data broken down by category, the account would need access to the data in the sources report. "currentlyPublished": true, "processingStatus": "", "emailTemplateMode": "DESIGN_MANAGER", "isRecipientFatigueSuppressionEnabled": null, Access to data from the Analytics API will depend on the connected HubSpot account's permissions. "pageExpiryEnabled": false, After using this function to update the path, you'll need to call the trackPageView function to track the view of the current page. If the account does not have access to the requested data, you will receive a 403 error response. "publishedById": 1230836, "rssEmailAuthorLineTemplate": "By {{post.author}}, Restore a previous version of the template, Get all pipelines for a specified object type, Supporting imports with the Ecommerce Bridge, Get all sync errors for a specific account, Get all sync errors for a specific account from a specific app, View subscription status of email address, Update subscription status of email address, Get campaign IDs with recent activity for a portal, Get campaign data for a particular Campaign, Get event data for a campaign or recipient, Submit form data (Supporting Authentication), Determine the buffer of a marketing email, Create or update a group of timeline events, Unenroll (remove) a contact from a workflow. These contacts were not sent your email. This resets the bounce status of the recipient, potentially allowing them to receive emails from your portal. this leads to all unknown visitors being associated with your placeholder contact. When you know a visitor's identity (e.g., email address), you can use theidentify function to set identities in the tracker. Get analytics data for HubSpot hosted content, Check for the existence of analytics data for an object type. "publishDate": 1553518847423,
- Graduation Dress 2022
- Digital Label Printing Machine
- Oneida Silver Platter Value
- New Apartment Construction Mountain View Ca
- Best Hop-on Hop-off Rome Bus Tour
- Cobleskill Golf Tournament
- Where To Buy Mushroom Compost In Bulk
- Undercarriage Lights Near Me
- Wind Quintet Sheet Music
- Project Audit Checklist
- Sea Breeze And Land Breeze Convection
- Madewell Ripped Jeans Policy
- How To Remove Oxidation From Plastic Shutters