Skip to content

Commit 366bfbb

Browse files
committed
Initial edits
1 parent 3f499bd commit 366bfbb

File tree

1 file changed

+56
-108
lines changed
  • src/connections/destinations/catalog/ambee-apis

1 file changed

+56
-108
lines changed
Lines changed: 56 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,40 @@
11
---
2-
title: "[]{#_txprw7e8ra85 .anchor}Segment Documentation--Ambee"
2+
title: "Ambee"
3+
hidden: true
4+
beta: true
5+
id:
36
---
47

5-
## **Ambee Destination**
6-
7-
title: Ambee Destination id: integration_id
8-
9-
{% include content/plan-grid.md name=\"actions\" %}
8+
{% include content/plan-grid.md name="actions" %}
109

1110
Ambee provides self-serve predictive analytics for businesses,
12-
leveraging machine learning to automate audience insights and
11+
using machine learning to automate audience insights and
1312
recommendations based on climate and environmental datasets. Ambee
1413
offers actionable air quality and pollen data that can reinforce your
1514
climate strategy, simplify personalization, and enhance business
1615
outcomes.
1716

1817
This destination is maintained by Ambee. For any issues with the
19-
destination, contact their [[Support
20-
Team]{.underline}](https://support.getambee.com/portal/en/home).
18+
destination, contact Ambee's [Support
19+
Team](https://support.getambee.com/portal/en/home){:target="_blank"}.
2120

2221
{% include content/ajs-upgrade.md %}
2322

24-
### **Getting started**
23+
## Getting started
2524

26-
From the **Segment** web app, click **Catalog**, then click
27-
**Destinations**.
2825

29-
Find the **Destinations Actions** item in the left navigation, and click
26+
1. From the **Segment** web app, click **Catalog**, then click
27+
**Destinations**.
28+
2. Find the **Destinations Actions** item in the left navigation, and click
3029
it.
31-
32-
Click Configure **Ambee**
33-
34-
Select an existing Source to connect to **Ambee** (Actions).
30+
3. Click Configure **Ambee**
31+
4. Select an existing Source to connect to **Ambee** (Actions).
3532

3633
{% include components/actions-fields.html %}
3734

38-
## **Settings**
35+
## Settings
3936

40-
### **Segment Write Key**
37+
### Segment write key
4138

4239
The write key is a unique identifier for each Source. It lets Segment
4340
know which Source is sending the data and which destinations should
@@ -46,96 +43,67 @@ receive that data.
4643
To find a write key, you first need to create a non-Cloud Source such as
4744
a website, server, or mobile source.
4845

49-
Then, in the Source, go to **Settings,** and then go to **API Keys**.
46+
Then, in the Source, navigate to **Settings** > **API Keys**.
5047

51-
###
5248

53-
### **API Key**
49+
### API Key
5450

55-
To start working with Ambee as your destination, you will require
56-
Ambee's API Key. Sign up for Ambee by visiting [[this
57-
website]{.underline}](https://auth.ambeedata.com/users/register?redirectUrl=https://api-dashboard.getambee.com).
51+
To start working with Ambee as your destination, you'll need
52+
Ambee's API Key. Sign up for Ambee [here](https://auth.ambeedata.com/users/register?redirectUrl=https://api-dashboard.getambee.com){:target="_blank"}.
5853

5954
Once you are signed in, you will get your limited-period API key on the
60-
dashboard\'s homepage. If your use case requires data in bulk, you will
61-
need to subscribe to Ambee's [[enterprise
62-
plan]{.underline}](https://www.getambee.com/pricing). During
63-
subscription, you will need to specify your choice of API--air quality
64-
and/or pollen. []{.mark}
55+
dashboard's homepage. If your use case requires data in bulk, you'll
56+
need to subscribe to Ambee's [enterprise
57+
plan](https://www.getambee.com/pricing){:target="_blank"}. During
58+
subscription, you'll need to specify your choice of API: **air quality**
59+
and/or **pollen**.
6560

6661
After subscription, you can use Ambee's air quality and/or pollen data
6762
by pasting your API key under **the API Key section** in **Mapping**.
6863

69-
## **Ambee Destination Mapping**
64+
## Ambee Destination Mapping
7065

71-
### **Ambee Air Quality Subscription**
66+
### Ambee Air Quality Subscription
7267

7368
Ambee's air quality subscription helps you personalize and position your
7469
messaging via emails, sms, and push notifications to improve user
7570
engagement on your website based on air quality triggers for locations
7671
across the world. You can also retarget messaging based on your user's
77-
geo-location, for example-
72+
geo-location, for example:
7873

79-
- Promote the sale of your EVs in highly polluted areas
74+
- Promote the sale of your EVs in highly polluted areas
8075

81-
- Advertise anti-pollution products like masks, skincare, etc., during
82-
> highly polluted durations
76+
- Advertise anti-pollution products like masks, skincare, and more, during highly polluted durations
8377

84-
- Showcase ads for smart air purifiers in highly polluted localities
78+
- Showcase ads for smart air purifiers in highly polluted localities
8579

8680
The table below shows the AQI risk levels, their associated value, and
8781
what each category means for the public. Ambee uses globally valid data
8882
that follows US EPA standards to provide relevant recommendations. If
89-
you are subscribed to **air quality,** you can select the risk levels
83+
you are subscribed to **air quality** you can select the risk levels
9084
for AQI from the drop-down box under **the air quality** section.
9185

92-
------------------------------------------------------------------------
93-
AQI risk Index Values What it means
94-
levels
95-
------------- --------------- ------------------------------------------
96-
Good 0 - 50 Air quality is good and poses little or no
97-
risk.
98-
99-
Moderate 51 - 100 Air quality is acceptable; however, there
100-
may be some health concerns for a small
101-
number of extremely sensitive people.
102-
103-
Unhealthy For 101 - 150 When air quality is in this range, people
104-
Sensitive in sensitive groups may experience health
105-
Groups effects when engaging in outdoor
106-
activities.
107-
108-
Unhealthy 151 - 200 When air quality is in this range,
109-
everyone who is active outdoors may
110-
experience effects. Members of sensitive
111-
groups are likely to experience more
112-
serious effects.
113-
114-
Very 201 - 300 When air quality is in this range, it is
115-
Unhealthy expected that there will be widespread
116-
effects among the general population and
117-
more serious effects in members of
118-
sensitive groups.
119-
120-
Hazardous 301 - 400 Air quality in this range triggers health
121-
warnings of emergency conditions. The
122-
entire population is more likely to be
123-
affected by serious health effects.
124-
125-
401 - 500
126-
------------------------------------------------------------------------
127-
128-
### **Ambee Pollen Subscription **
86+
| AQI risk levels | Index Values | What it means |
87+
|---------------------|-----------------|-----------------------------|
88+
| Good | 0-50 | Air quality is good and poses little or no risk. |
89+
| Moderate | 51-100 | Air quality is acceptable; however, there may be some health concerns for a small number of extremely sensitive people. |
90+
| Unhealthy for sensitive groups | 101-150 | When air quality is in this range, people in sensitive groups may experience health effects when engaging in outdoor activities. |
91+
| Unhealthy | 151-200 | When air quality is in this range, everyone who is active outdoors may experience effects. Members of sensitive groups are likely to experience more serious effects. |
92+
| Very unhealthy | 201-300 | When air quality is in this range, it is expected that there will be widespread effects among general population and more serious effects in members of sensitive groups. |
93+
| Hazardous | 301-400 | Air quality in this range triggers health warnings of emergency conditions. The entire population is more likely to be affected by serious health effects. |
94+
| | 401-500 | |
95+
96+
### Ambee Pollen Subscription
12997

13098
Ambee's pollen subscription helps you contextualize and hyper-target
131-
your marketing and advertising campaigns via emails, sms, and push
99+
your marketing and advertising campaigns with emails, sms, and push
132100
notifications to improve user engagement with the help of pollen
133101
triggers for locations across the world. You can also personalize your
134-
ad content based on the user's geolocation, for example-
102+
ad content based on the user's geolocation, for example:
135103

136-
- Advertise anti-allergy tissues based on high pollen condition
104+
- Advertise anti-allergy tissues based on high pollen condition
137105

138-
- Promote OTC medicines to allergy sufferers
106+
- Promote OTC medicines to allergy sufferers
139107

140108
The risk levels below are recommended by NAB to understand the risks
141109
they are exposed to, and it helps them take preventative measures to
@@ -144,35 +112,15 @@ provide accurate insights. If you are subscribed to **pollen**, you can
144112
select the risk levels for pollen from the drop-down box under the
145113
**pollen** section.
146114

147-
------------------------------------------------------------------------
148-
Risk Level Tree Grass Weed What it means
149-
------------- ---------- ----------- ----------- -----------------------
150-
Low 0-95 0-29 0-20 Individuals susceptible
151-
to pollen may
152-
experience mild
153-
allergic symptoms
154-
155-
Moderate 96-207 30-60 21-77 Many individuals
156-
sensitive to pollen may
157-
experience allergic
158-
symptoms
159-
160-
High 208-703 61-341 78-266 Most individuals with
161-
any sensitivity to
162-
pollen will experience
163-
allergic symptoms.
164-
Extremely sensitive
165-
groups could experience
166-
serious symptoms
167-
168-
Very High 704+ 342+ 267+ Almost all individuals
169-
with any sensitivity to
170-
pollen will experience
171-
symptoms.
172-
------------------------------------------------------------------------
173-
174-
### **IP Address**
115+
| Risk Level | Tree | Grass | Weed | What it means |
116+
|---------------|---------|-----------|-------------|-----------------|
117+
| Low | 0-95 | 0-29 | 0-20 | Individuals susceptible to pollen may experience mild allergic symtoms. |
118+
| Moderate | 96-207 | 30-60 | 21-77 | Many individuals sensitive to pollen may experience allergic symptoms. |
119+
| High | 208-703 | 61-341 | 78-266 | Most individuals with any sensitivty to pollen will experience allergic symptoms. Extremely sensitive groups could experience serious symptoms. |
120+
| Very High | 704+ | 342+ | 267+ | Almost all individuals with any sensitivity to pollen will experience symptoms. |
121+
122+
### IP Address
175123

176124
Ambee will fetch the user's IP address to trigger air quality and/or
177-
pollen notifications for device mode --- analytics.js or mobile
125+
pollen notifications for device mode with analytics.js or mobile
178126
(android/iOS).

0 commit comments

Comments
 (0)