-
Notifications
You must be signed in to change notification settings - Fork 393
Accoil Analytics destination action documentation #7047
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
forstisabella
merged 4 commits into
segmentio:develop
from
sherlockscore:AAD-428-accoil-analytics
Oct 3, 2024
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
119 changes: 119 additions & 0 deletions
119
src/connections/destinations/catalog/accoil-analytics/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
--- | ||
title: Accoil Destination | ||
hide-boilerplate: true | ||
hide-dossier: false | ||
beta: true | ||
private: true | ||
--- | ||
|
||
{% include content/plan-grid.md name="actions" %} | ||
|
||
<!-- Include a brief description of the destination here, along with a link to your website. --> | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
[Accoil](https://www.accoil.com) is a product analytics platform built specifically for B2B go-to-market (GTM) teams, including product, sales, marketing, customer success, and support. It enables you to track feature adoption, monitor user journeys, and enhance activation and conversion rates. By sending your product event data to Accoil via Segment, you unlock actionable insights that drive informed decisions across your organization. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Any questions or for help, please [contact us](https://help.accoil.com). | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. --> | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Benefits of Integrating with Accoil | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- **Comprehensive Analytics**: Gain detailed insights into your product's performance across features, customer segments, and stages of the user journey. | ||
- **Enhanced Collaboration**: Create account- and user-level audiences that trigger timely actions across tools like Slack, Intercom, HubSpot, and more. | ||
- **Actionable Insights**: Teams from sales to customer success can leverage Accoil’s data to make informed decisions, improve engagement, and uncover growth opportunities. | ||
- **Seamless Integration**: Accoil integrates effortlessly with popular tools such as HubSpot, Intercom, Slack, and Segment itself, making it easy to utilize your product data within your existing workflows. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- **User-Friendly Interface**: Designed to be intuitive, Accoil allows any team to build and use product engagement profiles without needing advanced analytical skills. | ||
|
||
## How It Works | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Accoil is most effective when used with Segment. Here’s how it functions: | ||
|
||
1. **Send Event Data**: Use Segment to funnel your product event data into Accoil. Focus on the events that are most significant to your product and users. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
2. **Build Engagement Profiles**: Teams can easily create and manage product engagement profiles, helping monitor feature adoption, user engagement, and buyer journey stages. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
3. **Connect to Your Tools**: Once your profiles are set up, Accoil connects to your GTM tools—like Slack, Intercom, HubSpot, and more. With detailed account and user insights, teams can take meaningful actions, such as alerting sales about accounts that have reached key milestones or notifying customer success about potential churn risks. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Getting Started | ||
|
||
To start using the Accoil destination: | ||
|
||
1. **Access the Destination Catalog**: In your Segment workspace, navigate to the Catalog page and search for "Accoil." | ||
2. **Add the Destination**: Select Accoil from the results and click "Add Destination." | ||
3. **Connect a Source**: Choose the Segment source you want to connect to Accoil. | ||
4. **API Key Setup**: In your Accoil dashboard, find your API Key under **General Account Settings**. Copy this API Key. | ||
5. **Configure in Segment**: Paste the API Key into the Accoil destination settings within Segment, then click "Connect" to complete the integration. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. --> | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
{% include components/actions-fields.html %} | ||
|
||
<!-- | ||
Additional Context | ||
|
||
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping. | ||
--> | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Supported Methods | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Accoil supports the following Segment methods, which map directly to Accoil’s API: | ||
|
||
**1. Identify** | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
**Purpose**: Recognizes individual users and their attributes. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
**Example Call**: | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
```javascript | ||
analytics.identify('userId123', { | ||
email: '[email protected]', | ||
name: 'John Doe', | ||
createdAt: '2023-05-12T08:00:00Z' // ISO 8601 or Unix timestamp format | ||
}); | ||
``` | ||
|
||
**2. Group** | ||
|
||
**Purpose**: Links users to accounts and records account-level attributes. | ||
|
||
**Example Call**: | ||
```javascript | ||
analytics.group('accountId123', { | ||
name: 'Example Company', | ||
createdAt: '2021-03-15T09:00:00Z', // ISO 8601 or Unix timestamp format | ||
mrr: 3000, | ||
status: 'active' | ||
}); | ||
``` | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
**3. Track** | ||
|
||
**Purpose**: Records specific user actions, such as "Login" or "Purchase." | ||
|
||
**Recommendation:** Use the Noun_Verb format to name your events, e.g., `Report Created`, `Purchase Completed`. | ||
|
||
**Example Call**: | ||
```javascript | ||
analytics.track('Purchase Completed', { | ||
item: 'Book', | ||
price: 25.00 | ||
}); | ||
``` | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
**4. Page and Screen** | ||
|
||
**Purpose**: Converts navigation calls into Track events to monitor user interactions within your product. | ||
|
||
**Example Calls**: | ||
```javascript | ||
analytics.page('Home Page'); | ||
analytics.screen('Dashboard'); | ||
``` | ||
|
||
**In Accoil**: These calls are transformed into events such as `Page Viewed Home Page` and `Screen Viewed Dashboard`, with the page or screen name as the event name. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Key Notes | ||
|
||
- **Created At Date**: Ensure the `createdAt` field for users and accounts is in ISO 8601 or Unix timestamp format for accurate tenure tracking. | ||
- **Trait Handling**: Accoil stores traits sent with Identify and Group calls, but traits passed with Track calls are not stored. Only event names and counts are recorded. | ||
- **Event Aggregation**: Accoil simplifies event tracking by aggregating daily event counts. | ||
- **Page and Screen Calls**: These calls are automatically converted into Track events for easier monitoring of user navigation. | ||
|
||
This integration empowers your team to make data-driven decisions, improving your product and customer experiences. For further assistance, please contact the Accoil Support team. | ||
accoilmj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.