Skip to content

Commit 3f499bd

Browse files
giriraj0012giriraj0012
committed
ambee docs
1 parent 0b44e20 commit 3f499bd

File tree

1 file changed

+178
-0
lines changed
  • src/connections/destinations/catalog/ambee-apis

1 file changed

+178
-0
lines changed

‎src/connections/destinations/catalog/ambee-apis/index.md

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
---
2+
title: "[]{#_txprw7e8ra85 .anchor}Segment Documentation--Ambee"
3+
---
4+
5+
## **Ambee Destination**
6+
7+
title: Ambee Destination id: integration_id
8+
9+
{% include content/plan-grid.md name=\"actions\" %}
10+
11+
Ambee provides self-serve predictive analytics for businesses,
12+
leveraging machine learning to automate audience insights and
13+
recommendations based on climate and environmental datasets. Ambee
14+
offers actionable air quality and pollen data that can reinforce your
15+
climate strategy, simplify personalization, and enhance business
16+
outcomes.
17+
18+
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).
21+
22+
{% include content/ajs-upgrade.md %}
23+
24+
### **Getting started**
25+
26+
From the **Segment** web app, click **Catalog**, then click
27+
**Destinations**.
28+
29+
Find the **Destinations Actions** item in the left navigation, and click
30+
it.
31+
32+
Click Configure **Ambee**
33+
34+
Select an existing Source to connect to **Ambee** (Actions).
35+
36+
{% include components/actions-fields.html %}
37+
38+
## **Settings**
39+
40+
### **Segment Write Key**
41+
42+
The write key is a unique identifier for each Source. It lets Segment
43+
know which Source is sending the data and which destinations should
44+
receive that data.
45+
46+
To find a write key, you first need to create a non-Cloud Source such as
47+
a website, server, or mobile source.
48+
49+
Then, in the Source, go to **Settings,** and then go to **API Keys**.
50+
51+
###
52+
53+
### **API Key**
54+
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).
58+
59+
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}
65+
66+
After subscription, you can use Ambee's air quality and/or pollen data
67+
by pasting your API key under **the API Key section** in **Mapping**.
68+
69+
## **Ambee Destination Mapping**
70+
71+
### **Ambee Air Quality Subscription**
72+
73+
Ambee's air quality subscription helps you personalize and position your
74+
messaging via emails, sms, and push notifications to improve user
75+
engagement on your website based on air quality triggers for locations
76+
across the world. You can also retarget messaging based on your user's
77+
geo-location, for example-
78+
79+
- Promote the sale of your EVs in highly polluted areas
80+
81+
- Advertise anti-pollution products like masks, skincare, etc., during
82+
> highly polluted durations
83+
84+
- Showcase ads for smart air purifiers in highly polluted localities
85+
86+
The table below shows the AQI risk levels, their associated value, and
87+
what each category means for the public. Ambee uses globally valid data
88+
that follows US EPA standards to provide relevant recommendations. If
89+
you are subscribed to **air quality,** you can select the risk levels
90+
for AQI from the drop-down box under **the air quality** section.
91+
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 **
129+
130+
Ambee's pollen subscription helps you contextualize and hyper-target
131+
your marketing and advertising campaigns via emails, sms, and push
132+
notifications to improve user engagement with the help of pollen
133+
triggers for locations across the world. You can also personalize your
134+
ad content based on the user's geolocation, for example-
135+
136+
- Advertise anti-allergy tissues based on high pollen condition
137+
138+
- Promote OTC medicines to allergy sufferers
139+
140+
The risk levels below are recommended by NAB to understand the risks
141+
they are exposed to, and it helps them take preventative measures to
142+
reduce their exposure to pollen. Ambee uses the NAB-compliant index to
143+
provide accurate insights. If you are subscribed to **pollen**, you can
144+
select the risk levels for pollen from the drop-down box under the
145+
**pollen** section.
146+
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**
175+
176+
Ambee will fetch the user's IP address to trigger air quality and/or
177+
pollen notifications for device mode --- analytics.js or mobile
178+
(android/iOS).

0 commit comments

Comments
 (0)