|
| 1 | +--- |
| 2 | +# The end name should be similar to `Slack Destination` |
| 3 | +title: Avo |
| 4 | +beta: true |
| 5 | +--- |
| 6 | + |
| 7 | +With [Avo](https://avo.app) Inspector, data quality is no longer a dream, it’s a workflow. |
| 8 | + |
| 9 | +[Inspector](https://www.avo.app/data-observability) 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. |
| 10 | + |
| 11 | +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**. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. --> |
| 16 | + |
| 17 | +{% include content/plan-grid.md name="actions" %} |
| 18 | + |
| 19 | +<!-- Include a brief description of the destination here, along with a link to your website. --> |
| 20 | + |
| 21 | +<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. --> |
| 22 | + |
| 23 | +<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. → |
| 24 | +
|
| 25 | +### Track events |
| 26 | +
|
| 27 | +Currently the Integration only receives `Track` events. |
| 28 | +
|
| 29 | +Example of track call: |
| 30 | +
|
| 31 | +```js |
| 32 | +analytics.track("Login", { |
| 33 | + userName: "John", |
| 34 | + city: "San Fransisco" |
| 35 | + age: 32 |
| 36 | +}); |
| 37 | +``` |
| 38 | +
|
| 39 | +This track call is translated into a event signature that is sent to the inspector API |
| 40 | +
|
| 41 | +```js |
| 42 | +{ |
| 43 | + "eventName": "Login", |
| 44 | + "properties": [ |
| 45 | + {"userName": "string"}, |
| 46 | + {"city": "string"} |
| 47 | + {"age": "integer"} |
| 48 | + ] |
| 49 | +} |
| 50 | +``` |
| 51 | +
|
| 52 | +
|
| 53 | +
|
| 54 | +
|
| 55 | +## Getting started |
| 56 | +
|
| 57 | +1. From the Segment web app, click **Catalog**, then click **Destinations**. |
| 58 | +2. Find the Destinations Actions item in the left navigation, and click it. |
| 59 | +3. Click **Configure Avo**. |
| 60 | +4. Select a source to connect to **Avo** (Actions). |
| 61 | +
|
| 62 | +<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. --> |
| 63 | + |
| 64 | +{% include components/actions-fields.html %} |
| 65 | + |
| 66 | +<!-- |
| 67 | +Additional Context |
| 68 | +
|
| 69 | +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. |
| 70 | +--> |
| 71 | + |
| 72 | +## Destination Settings |
| 73 | + |
| 74 | +1. Copy the **API Key** from Avo into the field `API Key` in settings. |
| 75 | + |
| 76 | +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**) |
| 77 | +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. |
| 78 | + |
| 79 | +## Getting Avo API key |
| 80 | + |
| 81 | +Before connecting the segment source to Avo, you will need an api key for your source. |
| 82 | + |
| 83 | +1. Create your Avo workspace at avo.app (If you don’t have one already) |
| 84 | + |
| 85 | +2. From the Avo workspace sidebar, select **Sources**. |
| 86 | +3. Select an existing source or create a new one. (We recommend naming your Avo sources the same as your Segment sources, for example "Web", "IOS", "Android") |
| 87 | +  |
| 88 | +4. Press the **Inspector Setup** tab inside the Avo source |
| 89 | +5. Copy the API Key |
| 90 | +  |
0 commit comments