Skip to content

Commit f559f27

Browse files
Merge pull request #6003 from avohq/avo-destination-docs
Avo destination docs
2 parents 29ac1a0 + 4798877 commit f559f27

File tree

5 files changed

+75
-0
lines changed

5 files changed

+75
-0
lines changed
565 KB
Loading
100 KB
Loading
53.6 KB
Loading
531 KB
Loading
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Avo Destination
3+
id: 65c2465d0d7d550aa8e7e5c6
4+
beta: true
5+
hidden: true
6+
redirect_from: "/connections/destinations/catalog/actions-avo/"
7+
---
8+
9+
With [Avo](https://avo.app){:target="\_blank”} Inspector, data quality is no longer a dream, it’s a workflow.
10+
11+
[Inspector](https://www.avo.app/data-observability){:target="\_blank”} lets you find, triage, fix, and prevent data quality issues in your product analytics. Launch Inspector to discover all your data quality issues and systematically work towards better data, one resolved issue at a time.
12+
13+
The Avo Inspector destination automatically extracts event schemas from your product events, sending only the signatures from the connected Segment sources to the Inspector API. **Avo Inspector receives no PII data from your source**.
14+
15+
16+
{% include content/plan-grid.md name="actions" %}
17+
18+
## Supported methods
19+
20+
### Track events
21+
22+
The Avo destination supports Track events.
23+
24+
Example of Track call:
25+
26+
```js
27+
analytics.track("Login", {
28+
userName: "John",
29+
city: "San Fransisco"
30+
age: 32
31+
});
32+
```
33+
34+
This Track call is translated into a event signature that is sent to Avo's Inspector API.
35+
36+
```js
37+
{
38+
"eventName": "Login",
39+
"properties": [
40+
{"userName": "string"},
41+
{"city": "string"}
42+
{"age": "integer"}
43+
]
44+
}
45+
```
46+
47+
## Getting started
48+
49+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
50+
2. Find the Destinations Actions item in the left navigation, and click it.
51+
3. Select Avo from the list of destinations, then click **Add destination**.
52+
4. Select a source to connect to Avo (Actions) and click **Next**.
53+
5. Enter a name for your Avo (Actions) destination and click **Create destination**.
54+
55+
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
56+
57+
{% include components/actions-fields.html %}
58+
59+
## Getting Avo API key
60+
Before connecting the segment source to Avo, you will need an API key for your source.
61+
62+
1. Create your Avo workspace at avo.app (If you don’t have one already).
63+
2. From the Avo workspace sidebar, select **Sources**.
64+
3. Select an existing source or create a new one. (Avo recommends naming your Avo sources the same as your Segment sources, for example "Web", "iOS", "Android")
65+
![Select a source](images/select-source.png)
66+
4. Click the **Inspector Setup** tab in the Avo source
67+
5. Copy the API Key
68+
![Copy API key](images/api-key.png)
69+
70+
## Destination settings
71+
1. Copy the **API Key** from Avo into the field `API Key` in settings.
72+
2. Select an environment you'd like the data to go to within Avo. It should reflect from what environment the source is receiving data from. (**Production** / **Development** / **Staging**)
73+
3. **(Optional):** If you have an event property describing the app release version of your source you can provide it under App Version. By default the destination attempts to extract your app release version from `{context.app.version}` which defaults to `unversioned` if that does not exist. Having accurate app release versions in Avo Inspector will help you identify which releases an issue is impacting, and monitor for regressions in future releases after you’ve resolved the issue.
74+
75+
![Select a source](images/avo-destination.png)

0 commit comments

Comments
 (0)