Introduction
The Beaconstac API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
To authorize, use this code:
# With shell, you can just pass the correct header with each request
curl "https://api.beaconstac.com/api/2.0/"
-H "Authorization: Token YOUR_TOKEN"
Make sure to replace
YOUR_TOKENwith your API key.
The Beaconstac API uses API key to authenticate requests.
Your API key carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
You can find your developer token by using the following steps.
- Login to the Beaconstac dashboard.
- Go to your 'Account' section using the drop-down on the top-right.
- In the 'Account Details' section, copy the 'Developer Token' value.
Beaconstac expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: Token YOUR_TOKEN
API
Campaign
Campaign is a type of marketing strategy in the form of Custom Url, Landing Pages or Feedback Forms to facilitate engagement between users and your business.
| Attributes |
|---|
id integer read only Unique identifier of the object |
content_type integer required Campaign Type (0 for 'No campaign') |
custom_url URL required if content_type is 1 User configured URL associated with the campaign |
markdown_card integer required if content_type is 2 Markdown card associated with the campaign |
form integer required if content_type is 3 Form associated with the campaign |
schedule integer required if content_type is 4 Schedule associated with the campaign |
app_links object required if content_type is 5 Schedule associated with the campaign |
vcard_plus object required if content_type is 6 Schedule associated with the campaign |
social_media object required if content_type is 8 Schedule associated with the campaign |
facebook_page object required if content_type is 9 Schedule associated with the campaign |
coupon object required if content_type is 10 Schedule associated with the campaign |
business_card object required if content_type is 11 Schedule associated with the campaign |
pdf object required if content_type is 13 Schedule associated with the campaign |
restaurant_menu object required if content_type is 14 Schedule associated with the campaign |
phone object required if content_type is 4 Schedule associated with the campaign |
sms object required if content_type is 4 Schedule associated with the campaign |
email object required if content_type is 4 Schedule associated with the campaign |
start_date timestamp `` Starts the campaign from the specified date |
end_date timestamp `` Ends the campaign on the specified date |
age_gate integer `` Prompts an age gate form when viewing the contents, restricting if viewer is younger than specified age |
campaign_active boolean read only Current campaign status |
organization integer required read only Id of the organization to which the campaign belongs to |
created timestamp read only Created timestamp of the campaign |
updated timestamp read only Last updated timestamp of the campaign |
Beaconstac API supports the following campaign types.
Landing Page (Markdown Card)
Create mobile-friendly landing pages for users to view/interact with your content.
| Attributes |
|---|
id integer read only Unique identifier of the object |
title string required Name of the Landing page |
version integer Version of landing page ( |
default boolean readonly Indicates whether page is a default page |
card_theme integer Theme for the page |
custom_theme integer ID of the custom theme |
custom_theme_data object readonly Details of the custom theme used |
theme_data object readonly Details of the card theme used |
markdown_body string Data to be displayed in markdown format |
html_body string Data to be displayed in HTML format |
css_body string CSS styling for the page |
organization integer required ID of the organization the Landing page belongs to |
maintainer integer ID of the user the Landing page is maintained by |
created timestamp read onlyCreation timestamp |
updated timestamp read onlyUpdation timestamp |
Get all landing pages
curl "https://api.beaconstac.com/api/2.0/markdowncards/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 26290,
"card_theme_data": {
"id": 7,
"name": "Best offers V2",
"css_link": "https://d3nvy39jvu7woe.cloudfront.net/static/css/markdown_template_css/best_offers_v2.css",
"example_markdown": "\n \n ## Half Price, Happy Hour\n ### Happy Hour Is Back\n \n [Know More](https://en.wikipedia.org/wiki/Cappuccino)\n \n [Call Us](tel:+12122475489) \n **Half off any Cappuccino blended beverage.\n Weekdays: 3pm to 5pm**. A cappuccino is an Italian coffee drink that is traditionally prepared with double espresso, hot milk, and steamed milk foam. Cream may be used instead of milk and is often topped with cinnamon. It is typically smaller in volume than a caffe latte, with a thicker layer of micro foam.",
"script_url": "https://d3nvy39jvu7woe.cloudfront.net/None",
"preview_image_url": "static/images/markdown_templates/best_offers/preview_image.jpg"
},
"version": 2,
"default": true,
"title": "Default markdown card",
"markdown_body": "\n\n## Half Price, Happy Hour\n### Happy Hour Is Back\n\n[Know More](https://en.wikipedia.org/wiki/Cappuccino)\n\n[Call Us](tel:+12122475489)\n\n**Half off any Cappuccino blended beverage.\nWeekdays: 3pm to 5pm**. A cappuccino is an Italian coffee drink that is traditionally prepared with double espresso, hot milk, and steamed milk foam. Cream may be used instead of milk and is often topped with cinnamon. It is typically smaller in volume than a caffè latte, with a thicker layer of micro foam.",
"html_body": "<p><img alt=\"\" src=\"https://d9ic2hg1x4ep8.cloudfront.net/default_images/coffee_default.jpeg\" /></p>\n<h2>Half Price, Happy Hour</h2>\n<h3>Happy Hour Is Back</h3>\n<p><a href=\"https://en.wikipedia.org/wiki/Cappuccino\">Know More</a></p>\n<p><a href=\"tel:+12122475489\">Call Us</a></p>\n<p><strong>Half off any Cappuccino blended beverage.\nWeekdays: 3pm to 5pm</strong>. A cappuccino is an Italian coffee drink that is traditionally prepared with double espresso, hot milk, and steamed milk foam. Cream may be used instead of milk and is often topped with cinnamon. It is typically smaller in volume than a caffè latte, with a thicker layer of micro foam.</p>",
"css_body": "",
"fb_pixel_id": "",
"fb_pixel_event": "",
"google_conversion_id": "",
"theme": null,
"kit_type": "AK",
"meta": {},
"created": "2020-04-21T15:57:02.521336+05:30",
"modified": "2020-11-06T10:51:01.082796+05:30",
"organization": 15406,
"maintainer": 15189,
"card_theme": 7,
"custom_theme": null,
"theme_data": {},
"custom_theme_data": {}
},
{
"id": 34918,
"card_theme_data": {
"id": 6,
"name": "Broadcast information",
"css_link": "https://d3nvy39jvu7woe.cloudfront.net/static/css/markdown_template_css/broadcast_information.css",
"example_markdown": "# Sub Urban Museum\n #### Unwinding the history of Mesopotamia\n \n The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n \n [READ MORE](https://www.google.com)\n",
"script_url": "https://d3nvy39jvu7woe.cloudfront.net/None",
"preview_image_url": "static/images/markdown_templates/broadcast_information/preview_image.jpg"
},
"version": 2,
"default": false,
"title": "loop",
"markdown_body": "# Sub Urban Museum\n#### Unwinding the history of Mesopotamia\n\nThe history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n\n[READ MORE](https://www.google.com)",
"html_body": "<h1 id=\"sub-urban-museum\" style=\"color: #9D9D9D\">Sub Urban Museum</h1>\n <h4 id=\"unwinding-the-history-of-mesopotamia\">Unwinding the history of Mesopotamia</h4>\n <p>The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.</p>\n <p><a href=\"https://www.google.com\">READ MORE</a></p>",
"css_body": "",
"fb_pixel_id": "",
"fb_pixel_event": "PageView",
"google_conversion_id": "",
"theme": "6",
"kit_type": "AK",
"meta": {
"creator_id": 15189,
"updater_id": 15189,
"creator_email": "example@mobstac.com",
"updater_email": "example@mobstac.com"
},
"created": "2020-08-21T18:55:28.359434+05:30",
"modified": "2020-08-21T18:55:28.367234+05:30",
"organization": 15406,
"maintainer": 15189,
"card_theme": 6,
"custom_theme": null,
"theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
},
"custom_theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
}
}
]
}
Returns a list of all landing pages. The landing pages are returned sorted by last updated.
Filter arguments:
title:exact,icontains
Search Fields:
title
Ordering fields:
-modified
Retrieve a Landing Page
curl "https://api.beaconstac.com/api/2.0/markdowncards/{markdown_card_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 34918,
"card_theme_data": {
"id": 6,
"name": "Broadcast information",
"css_link": "https://d3nvy39jvu7woe.cloudfront.net/static/css/markdown_template_css/broadcast_information.css",
"example_markdown": "# Sub Urban Museum\n #### Unwinding the history of Mesopotamia\n \n The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n \n [READ MORE](https://www.google.com)\n",
"script_url": "https://d3nvy39jvu7woe.cloudfront.net/None",
"preview_image_url": "static/images/markdown_templates/broadcast_information/preview_image.jpg"
},
"version": 2,
"default": false,
"title": "loop",
"markdown_body": "# Sub Urban Museum\n#### Unwinding the history of Mesopotamia\n\nThe history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n\n[READ MORE](https://www.google.com)",
"html_body": "<h1 id=\"sub-urban-museum\" style=\"color: #9D9D9D\">Sub Urban Museum</h1>\n <h4 id=\"unwinding-the-history-of-mesopotamia\">Unwinding the history of Mesopotamia</h4>\n <p>The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.</p>\n <p><a href=\"https://www.google.com\">READ MORE</a></p>",
"css_body": "",
"fb_pixel_id": "",
"fb_pixel_event": "PageView",
"google_conversion_id": "",
"theme": "6",
"kit_type": "AK",
"meta": {},
"created": "2020-08-21T18:55:28.359434+05:30",
"modified": "2020-08-21T18:55:28.367234+05:30",
"organization": 15406,
"maintainer": 15189,
"card_theme": 6,
"custom_theme": null,
"theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
},
"custom_theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
}
}
Retrieves the details of an existing landing page. You need only supply the unique landing page identifier that was returned upon listing.
Create new landing page
curl --location --request POST 'https://api.beaconstac.com/api/2.0/markdowncards/' \
--header 'Authorization: Token YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"organization": 15406,
"title": "",
"markdown_body": "",
"html_body": "",
"css_body": ""
}'
The above command returns JSON structured like this:
{
"id": 41818,
"card_theme_data": null,
"version": 2,
"default": false,
"title": "",
"markdown_body": "",
"html_body": "",
"css_body": "",
"fb_pixel_id": "",
"fb_pixel_event": "",
"google_conversion_id": "",
"theme": null,
"kit_type": "AK",
"meta": {},
"created": "2020-11-06T15:04:47.016755+05:30",
"modified": "2020-11-06T15:04:47.022575+05:30",
"organization": 15406,
"maintainer": 15189,
"card_theme": null,
"custom_theme": null,
"theme_data": {},
"custom_theme_data": {}
}
Update Landing Page
curl "https://api.beaconstac.com/api/2.0/maarkdowncards/{landing_page_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':landing_page_id, 'title':'new title'"
The above command returns JSON structured like this:
{
"id": 41819,
"card_theme_data": {
"id": 6,
"name": "Broadcast information",
"css_link": "https://d3nvy39jvu7woe.cloudfront.net/static/css/markdown_template_css/broadcast_information.css",
"example_markdown": "# Sub Urban Museum\n #### Unwinding the history of Mesopotamia\n \n The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n \n [READ MORE](https://www.google.com)\n",
"script_url": "https://d3nvy39jvu7woe.cloudfront.net/None",
"preview_image_url": "static/images/markdown_templates/broadcast_information/preview_image.jpg"
},
"version": 2,
"default": false,
"title": "t78",
"markdown_body": "# Sub Urban Museum\n#### Unwinding the history of Mesopotamia\n\nThe history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.\n\n[READ MORE](https://www.google.com)",
"html_body": "<h1 id=\"sub-urban-museum\" style=\"color: #9D9D9D\">Sub Urban Museum</h1>\n <h4 id=\"unwinding-the-history-of-mesopotamia\">Unwinding the history of Mesopotamia</h4>\n <p>The history of Mesopotamia ranges from the earliest human occupation in the Lower Paleolithic period up to the Late antiquity. This history is pieced together from evidence retrieved from archaeological excavations and, after the introduction of writing in the late 4th millennium BC, an increasing amount of historical sources.</p>\n <p><a href=\"https://www.google.com\">READ MORE</a></p>",
"css_body": "",
"fb_pixel_id": "",
"fb_pixel_event": "PageView",
"google_conversion_id": "",
"theme": "6",
"kit_type": "AK",
"meta": {
"creator_id": 15189,
"updater_id": 15189,
"creator_email": "example@mobstac.com",
"updater_email": "example@mobstac.com"
},
"created": "2020-11-06T15:20:18.026375+05:30",
"modified": "2020-11-06T15:20:18.032442+05:30",
"organization": 15406,
"maintainer": 15189,
"card_theme": 6,
"custom_theme": null,
"theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
},
"custom_theme_data": {
"id": "6",
"font": "PT Sans",
"name": "Broadcast info",
"colors": {
"text": "#ffffff",
"buttonBackground": "#E9DD26",
"buttonText": "#4a4a4a",
"backgroundColor": "#282828"
},
"background": {
"href": "https://d3nvy39jvu7woe.cloudfront.net/static/images/markdown_templates/broadcast_information/background.jpg",
"brightness": 0,
"layout": ""
}
}
}
Updates the specified landing page by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the Landing Page object.
Forms
Create Feedback Forms for collecting information for surveys, maarketing etc from your customers.
| Attributes |
|---|
id integer read only Unique identifier of the object |
title string required Name of the Landing page |
form_id integer read only Unique identity field for Form |
default boolean readonly Indicates whether page is a default form |
sms_structure object Structure to send SMS based on Thank You screen seen |
email_structure object Structure to receive email based on Thank You screen seen |
meta object readonly meta fields for Form |
url URL readonly URL to preview the Form |
form_response_count integer read onlyTotal number of responses received by the Form |
form_type stringtype of the Feedback Form |
form_structure object Complete structure of the Form |
organization integer required ID of the organization the Landing page belongs to |
maintainer integer ID of the user the Landing page is maintained by |
created timestamp read onlyCreation timestamp |
updated timestamp read onlyUpdation timestamp |
Get all Feedback Forms
curl "https://api.beaconstac.com/api/2.0/forms/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 49958,
"form_structure": {
"id": "EN78iMBv",
"type": "form",
"logic": [
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5"
},
{
"type": "choice",
"value": "6d60fc0e-6645-4966-84d8-10b90e37960e"
}
]
}
}
]
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "cca8c5c0-7536-4e95-bd88-4444066c2a39"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "1539a61e-73d8-48cb-a04d-3a61b082d689"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "80afef6d-fb4e-4dda-a973-99e9353dbb9a"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a"
}
]
}
}
]
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "ce43e9ac-2e20-4318-9a45-e2143f29c13b"
},
{
"type": "choice",
"value": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7"
}
]
}
}
]
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "083443e3-69e4-4bd8-a84a-05e6d14dabed"
},
{
"type": "choice",
"value": "a0d57cef-6603-45b1-9cac-eb7e6387c76a"
}
]
}
}
]
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "field",
"actions": [
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b"
}
},
"condition": {
"op": "greater_equal_than",
"vars": [
{
"type": "variable",
"value": "score"
},
{
"type": "constant",
"value": 1
}
]
}
},
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "8778f1ad-dfed-4e46-8c82-7c537acfcb63"
}
},
"condition": {
"op": "always",
"vars": []
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/ZyKW7J"
},
"title": "[COVID-19] Clinics and hospitals-",
"_links": {
"display": "https://eddypro.typeform.com/to/EN78iMBv"
},
"fields": [
{
"id": "LrVKT5W75DqM",
"ref": "cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd",
"type": "statement",
"title": "This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \n\nKeep us informed so that we can help you stay safe in these challenging times",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"id": "mxq7yWTTFp2z",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email",
"title": "What's your email id?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises"
},
"validations": {
"required": true
}
},
{
"id": "sfcPRmbPXrBh",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number",
"title": "What's your mobile number?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises",
"default_country_code": "US"
},
"validations": {
"required": true
}
},
{
"id": "Uyt2dOSfDf9b",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text",
"title": "Which doctor are you here to consult today?",
"properties": {
"description": "(Doctor name)"
},
"validations": {
"required": true
}
},
{
"id": "p4Dncq4aCPFL",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice",
"title": "Have you travelled to an international or domestic location in the past 3 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/fkaRQkYF6sdw",
"type": "image"
},
"properties": {
"choices": [
{
"id": "jzm8UyOGAr2S",
"ref": "6d60fc0e-6645-4966-84d8-10b90e37960e",
"label": "Yes"
},
{
"id": "rEZWuczwNMYI",
"ref": "0e002a1c-25aa-4eae-9563-66e2fe40665a",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "2f0xaRAQ105b",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice",
"title": "What's your gender?",
"properties": {
"choices": [
{
"id": "oTiJkMzdNzpz",
"ref": "fe283bb3-7f06-43d1-83e8-dd48e663e904",
"label": "Male"
},
{
"id": "W7pPmMR0yZZ2",
"ref": "bc0f3b2e-786d-41c4-b1e1-771878288ea5",
"label": "Female"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": false
}
},
{
"id": "VagUfsjqqv8M",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice",
"title": "Have you experienced any of these symptoms in the last 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/Wy9iM7YpWDKf",
"type": "image"
},
"properties": {
"choices": [
{
"id": "dOp0UwxhLaNp",
"ref": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650",
"label": "Cold and cough"
},
{
"id": "myhzlcJkFZxZ",
"ref": "c7955809-de34-43df-b116-102e16c85a86",
"label": "Running nose"
},
{
"id": "MOJBX0LuA4MR",
"ref": "cca8c5c0-7536-4e95-bd88-4444066c2a39",
"label": "Shortness of breath"
},
{
"id": "zvCcGulPnG2i",
"ref": "1539a61e-73d8-48cb-a04d-3a61b082d689",
"label": "Sore throat"
},
{
"id": "AG5zZRIwyXAi",
"ref": "80afef6d-fb4e-4dda-a973-99e9353dbb9a",
"label": "Fever"
},
{
"id": "4Rh5FP3b2kPj",
"ref": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a",
"label": "Unsure"
},
{
"id": "4WdWqbjUgfyn",
"ref": "e1b0c83f-704a-4526-be14-0b31572b84c1",
"label": "None of the above"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "MGyAC20eTLxR",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice",
"title": "Do any of your family members have the above symptoms?",
"attachment": {
"href": "https://images.typeform.com/images/bYducJ2kQEzi",
"type": "image"
},
"properties": {
"choices": [
{
"id": "Xm7HLpweaBmZ",
"ref": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7",
"label": "Yes"
},
{
"id": "Hus3HyZbz7Vt",
"ref": "90e2efeb-a40d-4540-a1b7-b5c0bfd177d1",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "bRxcw7475rQC",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice",
"title": "Have you been in contact with someone with flu in the past 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/QkbPABHjUrqQ",
"type": "image"
},
"properties": {
"choices": [
{
"id": "WbdRVnK5smN1",
"ref": "a0d57cef-6603-45b1-9cac-eb7e6387c76a",
"label": "Yes"
},
{
"id": "0lOo7nJPjsSc",
"ref": "88a8788c-adcf-47ad-af25-890ae332da53",
"label": "No"
},
{
"id": "3oxXV0eAn4x5",
"ref": "0b3f78b9-569e-4bb1-9fb9-c62ca505f466",
"label": "Not sure"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "TTsgOiIXpWfq",
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "statement",
"title": "I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response:\n{{form:all_answers}}\n\nTeam Beaconstac\n",
"subject": "Typeform: New response for {{form:title}}",
"recipients": [
"example@mobstac.com"
]
},
"respondent": {
"enabled": true,
"message": "Hello,\nWe’ve received your submission.\n{{form:all_answers}}\nThank you & have a nice day!",
"subject": "Typeform: Thank you for filling out {{form:title}}",
"recipient": "{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}"
}
},
"show_progress_bar": true,
"are_uploads_public": false,
"show_typeform_branding": false
},
"variables": {
"score": 0
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"welcome_screens": [
{
"id": "63wzoZe1KYAZ",
"ref": "c4474bbc-156f-4e1d-b585-057bd0461eaf",
"title": "We are dedicated to prevent the spread of the novel coronavirus.\n\nFill in the form to get access & enjoy a risk-free time inside!",
"attachment": {
"href": "https://images.typeform.com/images/ctp4n62CsDMm",
"type": "image"
},
"properties": {
"button_text": "GET STARTED",
"show_button": true
}
}
],
"thankyou_screens": [
{
"id": "Y3kFCjKvnSCW",
"ref": "8778f1ad-dfed-4e46-8c82-7c537acfcb63",
"title": "Present this screen at the entrance to get access",
"attachment": {
"href": "https://images.typeform.com/images/btDfqrgjA7wN",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "dfF2JIC8jbHQ",
"ref": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b",
"title": "Based on your answers, we have a few additional queries, please speak with our representative",
"attachment": {
"href": "https://images.typeform.com/images/yvbArZPNmXj5",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "DefaultTyScreen",
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "[COVID-19] Clinics and hospitals-",
"url": "https://eddypro.typeform.com/to/EN78iMBv",
"form_id": "EN78iMBv",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {},
"created": "2020-08-10T13:02:37.625442+05:30",
"updated": "2020-08-10T13:02:37.625457+05:30",
"organization": 15406,
"maintainer": null,
"beacons": [],
"form_response_count": 0
},
{
"id": 36089,
"form_structure": {
"id": "bDhj3L",
"theme": {
"href": "https://api.typeform.com/themes/paovnB"
},
"title": "My First Form",
"_links": {
"display": "https://eddypro.typeform.com/to/bDhj3L"
},
"fields": [
{
"id": "OSCqemyVcxLI",
"ref": "short_text_1_1587465774379",
"type": "short_text",
"title": "Name",
"validations": {
"required": true
}
},
{
"id": "DE0VQqzvlzXq",
"ref": "number_2_1587465774379",
"type": "number",
"title": "Age",
"validations": {
"required": false
}
},
{
"id": "cWc1GdugqN8u",
"ref": "statement_3_1587465774379",
"type": "statement",
"title": "Bloom",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"id": "KNWUvR8axps7",
"ref": "dropdown_4_1587465774379",
"type": "dropdown",
"title": "Choose one",
"properties": {
"choices": [
{
"label": "Generic"
},
{
"label": "Random"
},
{
"label": "Unique"
},
{
"label": "Blah"
}
],
"randomize": false,
"alphabetical_order": false
},
"validations": {
"required": false
}
},
{
"id": "J4riKwVFzXVA",
"ref": "website_5_1587465774379",
"type": "website",
"title": "Website",
"properties": {
"description": "your website"
},
"validations": {
"required": false
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response\n\n{{form:all_answers}}",
"subject": "Typeform: new response for {{form:title}}",
"recipients": [
"example@mobstac.com",
"test@gmail.com"
]
}
},
"show_progress_bar": true,
"show_typeform_branding": false
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"thankyou_screens": [
{
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "My First Form",
"url": "https://eddypro.typeform.com/to/bDhj3L",
"form_id": "bDhj3L",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {},
"created": "2020-04-21T16:10:11.337751+05:30",
"updated": "2020-04-21T16:12:54.996821+05:30",
"organization": 15406,
"maintainer": null,
"beacons": [],
"form_response_count": 2
}
]
}
Returns a list of all Feedback forms. The Forms are returned sorted by last updated.
Filter arguments:
title:exact,icontainsurl:exact,icontains
Search Fields:
titleurlform_idform_type
Ordering fields:
createdupdatedurltitle
Retrieve a Feedback Form
curl "https://api.beaconstac.com/api/2.0/markdowncards/{form_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 49958,
"form_structure": {
"id": "EN78iMBv",
"type": "form",
"logic": [
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5"
},
{
"type": "choice",
"value": "6d60fc0e-6645-4966-84d8-10b90e37960e"
}
]
}
}
]
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "cca8c5c0-7536-4e95-bd88-4444066c2a39"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "1539a61e-73d8-48cb-a04d-3a61b082d689"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "80afef6d-fb4e-4dda-a973-99e9353dbb9a"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a"
}
]
}
}
]
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "ce43e9ac-2e20-4318-9a45-e2143f29c13b"
},
{
"type": "choice",
"value": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7"
}
]
}
}
]
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "083443e3-69e4-4bd8-a84a-05e6d14dabed"
},
{
"type": "choice",
"value": "a0d57cef-6603-45b1-9cac-eb7e6387c76a"
}
]
}
}
]
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "field",
"actions": [
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b"
}
},
"condition": {
"op": "greater_equal_than",
"vars": [
{
"type": "variable",
"value": "score"
},
{
"type": "constant",
"value": 1
}
]
}
},
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "8778f1ad-dfed-4e46-8c82-7c537acfcb63"
}
},
"condition": {
"op": "always",
"vars": []
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/ZyKW7J"
},
"title": "[COVID-19] Clinics and hospitals-",
"_links": {
"display": "https://eddypro.typeform.com/to/EN78iMBv"
},
"fields": [
{
"id": "LrVKT5W75DqM",
"ref": "cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd",
"type": "statement",
"title": "This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \n\nKeep us informed so that we can help you stay safe in these challenging times",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"id": "mxq7yWTTFp2z",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email",
"title": "What's your email id?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises"
},
"validations": {
"required": true
}
},
{
"id": "sfcPRmbPXrBh",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number",
"title": "What's your mobile number?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises",
"default_country_code": "US"
},
"validations": {
"required": true
}
},
{
"id": "Uyt2dOSfDf9b",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text",
"title": "Which doctor are you here to consult today?",
"properties": {
"description": "(Doctor name)"
},
"validations": {
"required": true
}
},
{
"id": "p4Dncq4aCPFL",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice",
"title": "Have you travelled to an international or domestic location in the past 3 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/fkaRQkYF6sdw",
"type": "image"
},
"properties": {
"choices": [
{
"id": "jzm8UyOGAr2S",
"ref": "6d60fc0e-6645-4966-84d8-10b90e37960e",
"label": "Yes"
},
{
"id": "rEZWuczwNMYI",
"ref": "0e002a1c-25aa-4eae-9563-66e2fe40665a",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "2f0xaRAQ105b",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice",
"title": "What's your gender?",
"properties": {
"choices": [
{
"id": "oTiJkMzdNzpz",
"ref": "fe283bb3-7f06-43d1-83e8-dd48e663e904",
"label": "Male"
},
{
"id": "W7pPmMR0yZZ2",
"ref": "bc0f3b2e-786d-41c4-b1e1-771878288ea5",
"label": "Female"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": false
}
},
{
"id": "VagUfsjqqv8M",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice",
"title": "Have you experienced any of these symptoms in the last 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/Wy9iM7YpWDKf",
"type": "image"
},
"properties": {
"choices": [
{
"id": "dOp0UwxhLaNp",
"ref": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650",
"label": "Cold and cough"
},
{
"id": "myhzlcJkFZxZ",
"ref": "c7955809-de34-43df-b116-102e16c85a86",
"label": "Running nose"
},
{
"id": "MOJBX0LuA4MR",
"ref": "cca8c5c0-7536-4e95-bd88-4444066c2a39",
"label": "Shortness of breath"
},
{
"id": "zvCcGulPnG2i",
"ref": "1539a61e-73d8-48cb-a04d-3a61b082d689",
"label": "Sore throat"
},
{
"id": "AG5zZRIwyXAi",
"ref": "80afef6d-fb4e-4dda-a973-99e9353dbb9a",
"label": "Fever"
},
{
"id": "4Rh5FP3b2kPj",
"ref": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a",
"label": "Unsure"
},
{
"id": "4WdWqbjUgfyn",
"ref": "e1b0c83f-704a-4526-be14-0b31572b84c1",
"label": "None of the above"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "MGyAC20eTLxR",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice",
"title": "Do any of your family members have the above symptoms?",
"attachment": {
"href": "https://images.typeform.com/images/bYducJ2kQEzi",
"type": "image"
},
"properties": {
"choices": [
{
"id": "Xm7HLpweaBmZ",
"ref": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7",
"label": "Yes"
},
{
"id": "Hus3HyZbz7Vt",
"ref": "90e2efeb-a40d-4540-a1b7-b5c0bfd177d1",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "bRxcw7475rQC",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice",
"title": "Have you been in contact with someone with flu in the past 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/QkbPABHjUrqQ",
"type": "image"
},
"properties": {
"choices": [
{
"id": "WbdRVnK5smN1",
"ref": "a0d57cef-6603-45b1-9cac-eb7e6387c76a",
"label": "Yes"
},
{
"id": "0lOo7nJPjsSc",
"ref": "88a8788c-adcf-47ad-af25-890ae332da53",
"label": "No"
},
{
"id": "3oxXV0eAn4x5",
"ref": "0b3f78b9-569e-4bb1-9fb9-c62ca505f466",
"label": "Not sure"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "TTsgOiIXpWfq",
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "statement",
"title": "I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response:\n{{form:all_answers}}\n\nTeam Beaconstac\n",
"subject": "Typeform: New response for {{form:title}}",
"recipients": [
"example@mobstac.com"
]
},
"respondent": {
"enabled": true,
"message": "Hello,\nWe’ve received your submission.\n{{form:all_answers}}\nThank you & have a nice day!",
"subject": "Typeform: Thank you for filling out {{form:title}}",
"recipient": "{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}"
}
},
"show_progress_bar": true,
"are_uploads_public": false,
"show_typeform_branding": false
},
"variables": {
"score": 0
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"welcome_screens": [
{
"id": "63wzoZe1KYAZ",
"ref": "c4474bbc-156f-4e1d-b585-057bd0461eaf",
"title": "We are dedicated to prevent the spread of the novel coronavirus.\n\nFill in the form to get access & enjoy a risk-free time inside!",
"attachment": {
"href": "https://images.typeform.com/images/ctp4n62CsDMm",
"type": "image"
},
"properties": {
"button_text": "GET STARTED",
"show_button": true
}
}
],
"thankyou_screens": [
{
"id": "Y3kFCjKvnSCW",
"ref": "8778f1ad-dfed-4e46-8c82-7c537acfcb63",
"title": "Present this screen at the entrance to get access",
"attachment": {
"href": "https://images.typeform.com/images/btDfqrgjA7wN",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "dfF2JIC8jbHQ",
"ref": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b",
"title": "Based on your answers, we have a few additional queries, please speak with our representative",
"attachment": {
"href": "https://images.typeform.com/images/yvbArZPNmXj5",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "DefaultTyScreen",
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "[COVID-19] Clinics and hospitals-",
"url": "https://eddypro.typeform.com/to/EN78iMBv",
"form_id": "EN78iMBv",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {},
"created": "2020-08-10T13:02:37.625442+05:30",
"updated": "2020-08-10T13:02:37.625457+05:30",
"organization": 15406,
"maintainer": null,
"beacons": [],
"form_response_count": 0
}
Retrieves the details of an existing Feedback Form. You need only supply the unique Form identifier that was returned upon listing.
Create new Feedback Form
curl --location --request POST 'https://api.beaconstac.com/api/2.0/forms/' \
--header 'Authorization: Token e00a6e1c0068b9f04ac56ca5a6b2cbd483d5fb3e' \
--header 'Content-Type: application/json' \
--data-raw '{
"form_structure": {
"type": "form",
"logic": [
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5"
},
{
"type": "choice",
"value": "6d60fc0e-6645-4966-84d8-10b90e37960e"
}
]
}
}
]
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "cca8c5c0-7536-4e95-bd88-4444066c2a39"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "1539a61e-73d8-48cb-a04d-3a61b082d689"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "80afef6d-fb4e-4dda-a973-99e9353dbb9a"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a"
}
]
}
}
]
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "ce43e9ac-2e20-4318-9a45-e2143f29c13b"
},
{
"type": "choice",
"value": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7"
}
]
}
}
]
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "083443e3-69e4-4bd8-a84a-05e6d14dabed"
},
{
"type": "choice",
"value": "a0d57cef-6603-45b1-9cac-eb7e6387c76a"
}
]
}
}
]
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "field",
"actions": [
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b"
}
},
"condition": {
"op": "greater_equal_than",
"vars": [
{
"type": "variable",
"value": "score"
},
{
"type": "constant",
"value": 1
}
]
}
},
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "8778f1ad-dfed-4e46-8c82-7c537acfcb63"
}
},
"condition": {
"op": "always",
"vars": []
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/ZyKW7J"
},
"title": "Test Form",
"_links": {
"display": "https://eddypro.typeform.com/to/EN78iMBv"
},
"fields": [
{
"ref": "cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd",
"type": "statement",
"title": "This self-declaration form is put together in alignment with World Health Organization'\''s Covid-19 outbreak guidelines. \n\nKeep us informed so that we can help you stay safe in these challenging times",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email",
"title": "What'\''s your email id?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises"
},
"validations": {
"required": true
}
},
{
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number",
"title": "What'\''s your mobile number?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises",
"default_country_code": "US"
},
"validations": {
"required": true
}
},
{
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text",
"title": "Which doctor are you here to consult today?",
"properties": {
"description": "(Doctor name)"
},
"validations": {
"required": true
}
},
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice",
"title": "Have you travelled to an international or domestic location in the past 3 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/fkaRQkYF6sdw",
"type": "image"
},
"properties": {
"choices": [
{
"ref": "6d60fc0e-6645-4966-84d8-10b90e37960e",
"label": "Yes"
},
{
"ref": "0e002a1c-25aa-4eae-9563-66e2fe40665a",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice",
"title": "What'\''s your gender?",
"properties": {
"choices": [
{
"ref": "fe283bb3-7f06-43d1-83e8-dd48e663e904",
"label": "Male"
},
{
"ref": "bc0f3b2e-786d-41c4-b1e1-771878288ea5",
"label": "Female"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": false
}
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice",
"title": "Have you experienced any of these symptoms in the last 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/Wy9iM7YpWDKf",
"type": "image"
},
"properties": {
"choices": [
{
"ref": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650",
"label": "Cold and cough"
},
{
"ref": "c7955809-de34-43df-b116-102e16c85a86",
"label": "Running nose"
},
{
"ref": "cca8c5c0-7536-4e95-bd88-4444066c2a39",
"label": "Shortness of breath"
},
{
"ref": "1539a61e-73d8-48cb-a04d-3a61b082d689",
"label": "Sore throat"
},
{
"ref": "80afef6d-fb4e-4dda-a973-99e9353dbb9a",
"label": "Fever"
},
{
"ref": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a",
"label": "Unsure"
},
{
"ref": "e1b0c83f-704a-4526-be14-0b31572b84c1",
"label": "None of the above"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice",
"title": "Do any of your family members have the above symptoms?",
"attachment": {
"href": "https://images.typeform.com/images/bYducJ2kQEzi",
"type": "image"
},
"properties": {
"choices": [
{
"ref": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7",
"label": "Yes"
},
{
"ref": "90e2efeb-a40d-4540-a1b7-b5c0bfd177d1",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice",
"title": "Have you been in contact with someone with flu in the past 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/QkbPABHjUrqQ",
"type": "image"
},
"properties": {
"choices": [
{
"ref": "a0d57cef-6603-45b1-9cac-eb7e6387c76a",
"label": "Yes"
},
{
"ref": "88a8788c-adcf-47ad-af25-890ae332da53",
"label": "No"
},
{
"ref": "0b3f78b9-569e-4bb1-9fb9-c62ca505f466",
"label": "Not sure"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "statement",
"title": "I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response:\n{{form:all_answers}}\n\nTeam Beaconstac\n",
"subject": "Typeform: New response for {{form:title}}",
"recipients": [
"example@mobstac.com"
]
},
"respondent": {
"enabled": true,
"message": "Hello,\nWe’ve received your submission.\n{{form:all_answers}}\nThank you & have a nice day!",
"subject": "Typeform: Thank you for filling out {{form:title}}",
"recipient": "{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}"
}
},
"show_progress_bar": true,
"are_uploads_public": false,
"show_typeform_branding": false
},
"variables": {
"score": 0
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"welcome_screens": [
{
"ref": "c4474bbc-156f-4e1d-b585-057bd0461eaf",
"title": "We are dedicated to prevent the spread of the novel coronavirus.\n\nFill in the form to get access & enjoy a risk-free time inside!",
"attachment": {
"href": "https://images.typeform.com/images/ctp4n62CsDMm",
"type": "image"
},
"properties": {
"button_text": "GET STARTED",
"show_button": true
}
}
],
"thankyou_screens": [
{
"ref": "8778f1ad-dfed-4e46-8c82-7c537acfcb63",
"title": "Present this screen at the entrance to get access",
"attachment": {
"href": "https://images.typeform.com/images/btDfqrgjA7wN",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"ref": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b",
"title": "Based on your answers, we have a few additional queries, please speak with our representative",
"attachment": {
"href": "https://images.typeform.com/images/yvbArZPNmXj5",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "Test Form",
"url": "https://eddypro.typeform.com/to/EN78iMBv",
"form_id": "EN78iMBv",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {},
"created": "2020-08-10T13:02:37.625442+05:30",
"updated": "2020-08-10T13:02:37.625457+05:30",
"organization": 15406,
"beacons": [],
"form_response_count": 0
}'
The above command returns JSON structured like this:
{
"id": 54024,
"form_structure": {
"id": "jLMqrBWb",
"type": "form",
"logic": [
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5"
},
{
"type": "choice",
"value": "6d60fc0e-6645-4966-84d8-10b90e37960e"
}
]
}
}
]
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "cca8c5c0-7536-4e95-bd88-4444066c2a39"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "1539a61e-73d8-48cb-a04d-3a61b082d689"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "80afef6d-fb4e-4dda-a973-99e9353dbb9a"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a"
}
]
}
}
]
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "ce43e9ac-2e20-4318-9a45-e2143f29c13b"
},
{
"type": "choice",
"value": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7"
}
]
}
}
]
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "083443e3-69e4-4bd8-a84a-05e6d14dabed"
},
{
"type": "choice",
"value": "a0d57cef-6603-45b1-9cac-eb7e6387c76a"
}
]
}
}
]
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "field",
"actions": [
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b"
}
},
"condition": {
"op": "greater_equal_than",
"vars": [
{
"type": "variable",
"value": "score"
},
{
"type": "constant",
"value": 1
}
]
}
},
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "8778f1ad-dfed-4e46-8c82-7c537acfcb63"
}
},
"condition": {
"op": "always",
"vars": []
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/ZyKW7J"
},
"title": "Test Form",
"_links": {
"display": "https://eddypro.typeform.com/to/jLMqrBWb"
},
"fields": [
{
"id": "iujQmehHWkpv",
"ref": "cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd",
"type": "statement",
"title": "This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \n\nKeep us informed so that we can help you stay safe in these challenging times",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"id": "I7nuPFZhjE1K",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email",
"title": "What's your email id?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises"
},
"validations": {
"required": true
}
},
{
"id": "hJseJYIAeZEI",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number",
"title": "What's your mobile number?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises",
"default_country_code": "US"
},
"validations": {
"required": true
}
},
{
"id": "dTLRFH28YFK2",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text",
"title": "Which doctor are you here to consult today?",
"properties": {
"description": "(Doctor name)"
},
"validations": {
"required": true
}
},
{
"id": "EbrryKpXStuY",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice",
"title": "Have you travelled to an international or domestic location in the past 3 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/r2CKCdiPMd9V",
"type": "image"
},
"properties": {
"choices": [
{
"id": "ohcRUpEmwijj",
"ref": "6d60fc0e-6645-4966-84d8-10b90e37960e",
"label": "Yes"
},
{
"id": "hpka5skZ1nIr",
"ref": "0e002a1c-25aa-4eae-9563-66e2fe40665a",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "KH9u7f7VFoTV",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice",
"title": "What's your gender?",
"properties": {
"choices": [
{
"id": "360nrWWKRZnJ",
"ref": "fe283bb3-7f06-43d1-83e8-dd48e663e904",
"label": "Male"
},
{
"id": "TMEsbKqUfsak",
"ref": "bc0f3b2e-786d-41c4-b1e1-771878288ea5",
"label": "Female"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": false
}
},
{
"id": "OqjVKoTyVFDu",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice",
"title": "Have you experienced any of these symptoms in the last 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/yRu69EkHMZNg",
"type": "image"
},
"properties": {
"choices": [
{
"id": "WhzCOEpomwRb",
"ref": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650",
"label": "Cold and cough"
},
{
"id": "gcM6gKsyLxf8",
"ref": "c7955809-de34-43df-b116-102e16c85a86",
"label": "Running nose"
},
{
"id": "zU9elRGay8F9",
"ref": "cca8c5c0-7536-4e95-bd88-4444066c2a39",
"label": "Shortness of breath"
},
{
"id": "kLKdXzrGoC3N",
"ref": "1539a61e-73d8-48cb-a04d-3a61b082d689",
"label": "Sore throat"
},
{
"id": "FXddbPLMtE1a",
"ref": "80afef6d-fb4e-4dda-a973-99e9353dbb9a",
"label": "Fever"
},
{
"id": "b14kG1ZtduJz",
"ref": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a",
"label": "Unsure"
},
{
"id": "cax9N9NoPPuw",
"ref": "e1b0c83f-704a-4526-be14-0b31572b84c1",
"label": "None of the above"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "ETpJlnONBDGJ",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice",
"title": "Do any of your family members have the above symptoms?",
"attachment": {
"href": "https://images.typeform.com/images/8CBTm5GvHrww",
"type": "image"
},
"properties": {
"choices": [
{
"id": "5Rn7zBmmPNHd",
"ref": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7",
"label": "Yes"
},
{
"id": "YcK1JVDjXohR",
"ref": "90e2efeb-a40d-4540-a1b7-b5c0bfd177d1",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "GZykpXs0OZ5P",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice",
"title": "Have you been in contact with someone with flu in the past 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/dUh7kZPXXGvc",
"type": "image"
},
"properties": {
"choices": [
{
"id": "annon5z1FXhZ",
"ref": "a0d57cef-6603-45b1-9cac-eb7e6387c76a",
"label": "Yes"
},
{
"id": "2FUSodzYL2A5",
"ref": "88a8788c-adcf-47ad-af25-890ae332da53",
"label": "No"
},
{
"id": "nb2bUDb9uTvz",
"ref": "0b3f78b9-569e-4bb1-9fb9-c62ca505f466",
"label": "Not sure"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "jLVj77j8yzTP",
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "statement",
"title": "I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response:\n{{form:all_answers}}\n\nTeam Beaconstac\n",
"subject": "Typeform: New response for {{form:title}}",
"recipients": [
"example@mobstac.com"
]
},
"respondent": {
"enabled": true,
"message": "Hello,\nWe’ve received your submission.\n{{form:all_answers}}\nThank you & have a nice day!",
"subject": "Typeform: Thank you for filling out {{form:title}}",
"recipient": "{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}"
}
},
"show_progress_bar": true,
"are_uploads_public": false,
"show_time_to_complete": true,
"show_typeform_branding": false
},
"variables": {
"score": 0
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"welcome_screens": [
{
"id": "fj9xH9ygOieI",
"ref": "c4474bbc-156f-4e1d-b585-057bd0461eaf",
"title": "We are dedicated to prevent the spread of the novel coronavirus.\n\nFill in the form to get access & enjoy a risk-free time inside!",
"attachment": {
"href": "https://images.typeform.com/images/d32SKu3vqLBg",
"type": "image"
},
"properties": {
"button_text": "GET STARTED",
"show_button": true
}
}
],
"thankyou_screens": [
{
"id": "LIe8AepMKkEW",
"ref": "8778f1ad-dfed-4e46-8c82-7c537acfcb63",
"title": "Present this screen at the entrance to get access",
"attachment": {
"href": "https://images.typeform.com/images/XEgYmdcrYX3p",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "YJ9uZJcxDxum",
"ref": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b",
"title": "Based on your answers, we have a few additional queries, please speak with our representative",
"attachment": {
"href": "https://images.typeform.com/images/pT3fchZA2qfi",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "DefaultTyScreen",
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "Test Form",
"url": "https://eddypro.typeform.com/to/jLMqrBWb",
"form_id": "jLMqrBWb",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {
"creator_id": 15189,
"updater_id": 15189,
"creator_email": "example@mobstac.com",
"updater_email": "example@mobstac.com"
},
"created": "2020-11-06T16:45:21.449705+05:30",
"updated": "2020-11-06T16:45:21.457306+05:30",
"organization": 15406,
"maintainer": 15189,
"beacons": [],
"form_response_count": 0
}
Create Feedback Form in your account.
Update Landing Page
curl "https://api.beaconstac.com/api/2.0/formss/{form_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':form_id, 'title':'new title'"
The above command returns JSON structured like this:
{
"id": 54024,
"form_structure": {
"id": "jLMqrBWb",
"type": "form",
"logic": [
{
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5"
},
{
"type": "choice",
"value": "6d60fc0e-6645-4966-84d8-10b90e37960e"
}
]
}
}
]
},
{
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "cca8c5c0-7536-4e95-bd88-4444066c2a39"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "1539a61e-73d8-48cb-a04d-3a61b082d689"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "80afef6d-fb4e-4dda-a973-99e9353dbb9a"
}
]
}
},
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "5a0f2b02-2302-4029-bfaf-ddb3d9446713"
},
{
"type": "choice",
"value": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a"
}
]
}
}
]
},
{
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "ce43e9ac-2e20-4318-9a45-e2143f29c13b"
},
{
"type": "choice",
"value": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7"
}
]
}
}
]
},
{
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "field",
"actions": [
{
"action": "add",
"details": {
"value": {
"type": "constant",
"value": 1
},
"target": {
"type": "variable",
"value": "score"
}
},
"condition": {
"op": "is",
"vars": [
{
"type": "field",
"value": "083443e3-69e4-4bd8-a84a-05e6d14dabed"
},
{
"type": "choice",
"value": "a0d57cef-6603-45b1-9cac-eb7e6387c76a"
}
]
}
}
]
},
{
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "field",
"actions": [
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b"
}
},
"condition": {
"op": "greater_equal_than",
"vars": [
{
"type": "variable",
"value": "score"
},
{
"type": "constant",
"value": 1
}
]
}
},
{
"action": "jump",
"details": {
"to": {
"type": "thankyou",
"value": "8778f1ad-dfed-4e46-8c82-7c537acfcb63"
}
},
"condition": {
"op": "always",
"vars": []
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/ZyKW7J"
},
"title": "Test Form",
"_links": {
"display": "https://eddypro.typeform.com/to/jLMqrBWb"
},
"fields": [
{
"id": "iujQmehHWkpv",
"ref": "cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd",
"type": "statement",
"title": "This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \n\nKeep us informed so that we can help you stay safe in these challenging times",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
},
{
"id": "I7nuPFZhjE1K",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email",
"title": "What's your email id?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises"
},
"validations": {
"required": true
}
},
{
"id": "hJseJYIAeZEI",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number",
"title": "What's your mobile number?",
"properties": {
"description": "This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises",
"default_country_code": "US"
},
"validations": {
"required": true
}
},
{
"id": "dTLRFH28YFK2",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text",
"title": "Which doctor are you here to consult today?",
"properties": {
"description": "(Doctor name)"
},
"validations": {
"required": true
}
},
{
"id": "EbrryKpXStuY",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice",
"title": "Have you travelled to an international or domestic location in the past 3 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/r2CKCdiPMd9V",
"type": "image"
},
"properties": {
"choices": [
{
"id": "ohcRUpEmwijj",
"ref": "6d60fc0e-6645-4966-84d8-10b90e37960e",
"label": "Yes"
},
{
"id": "hpka5skZ1nIr",
"ref": "0e002a1c-25aa-4eae-9563-66e2fe40665a",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "KH9u7f7VFoTV",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice",
"title": "What's your gender?",
"properties": {
"choices": [
{
"id": "360nrWWKRZnJ",
"ref": "fe283bb3-7f06-43d1-83e8-dd48e663e904",
"label": "Male"
},
{
"id": "TMEsbKqUfsak",
"ref": "bc0f3b2e-786d-41c4-b1e1-771878288ea5",
"label": "Female"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": false
}
},
{
"id": "OqjVKoTyVFDu",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice",
"title": "Have you experienced any of these symptoms in the last 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/yRu69EkHMZNg",
"type": "image"
},
"properties": {
"choices": [
{
"id": "WhzCOEpomwRb",
"ref": "6c24ccce-a159-4cf6-866c-9cd4d3bb4650",
"label": "Cold and cough"
},
{
"id": "gcM6gKsyLxf8",
"ref": "c7955809-de34-43df-b116-102e16c85a86",
"label": "Running nose"
},
{
"id": "zU9elRGay8F9",
"ref": "cca8c5c0-7536-4e95-bd88-4444066c2a39",
"label": "Shortness of breath"
},
{
"id": "kLKdXzrGoC3N",
"ref": "1539a61e-73d8-48cb-a04d-3a61b082d689",
"label": "Sore throat"
},
{
"id": "FXddbPLMtE1a",
"ref": "80afef6d-fb4e-4dda-a973-99e9353dbb9a",
"label": "Fever"
},
{
"id": "b14kG1ZtduJz",
"ref": "e4af5729-08f4-433b-9e5c-c7fbf64cba7a",
"label": "Unsure"
},
{
"id": "cax9N9NoPPuw",
"ref": "e1b0c83f-704a-4526-be14-0b31572b84c1",
"label": "None of the above"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "ETpJlnONBDGJ",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice",
"title": "Do any of your family members have the above symptoms?",
"attachment": {
"href": "https://images.typeform.com/images/8CBTm5GvHrww",
"type": "image"
},
"properties": {
"choices": [
{
"id": "5Rn7zBmmPNHd",
"ref": "b7cb8a79-e557-4a3c-990c-9ac835c8c7c7",
"label": "Yes"
},
{
"id": "YcK1JVDjXohR",
"ref": "90e2efeb-a40d-4540-a1b7-b5c0bfd177d1",
"label": "No"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "GZykpXs0OZ5P",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice",
"title": "Have you been in contact with someone with flu in the past 2 weeks?",
"attachment": {
"href": "https://images.typeform.com/images/dUh7kZPXXGvc",
"type": "image"
},
"properties": {
"choices": [
{
"id": "annon5z1FXhZ",
"ref": "a0d57cef-6603-45b1-9cac-eb7e6387c76a",
"label": "Yes"
},
{
"id": "2FUSodzYL2A5",
"ref": "88a8788c-adcf-47ad-af25-890ae332da53",
"label": "No"
},
{
"id": "nb2bUDb9uTvz",
"ref": "0b3f78b9-569e-4bb1-9fb9-c62ca505f466",
"label": "Not sure"
}
],
"randomize": false,
"allow_other_choice": false,
"vertical_alignment": true,
"allow_multiple_selection": false
},
"validations": {
"required": true
}
},
{
"id": "jLVj77j8yzTP",
"ref": "00a0cdbb-12a2-4ce1-9e0d-806996936828",
"type": "statement",
"title": "I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information",
"properties": {
"hide_marks": false,
"button_text": "Continue"
}
}
],
"settings": {
"meta": {
"allow_indexing": false
},
"is_trial": false,
"language": "en",
"is_public": true,
"progress_bar": "percentage",
"notifications": {
"self": {
"enabled": true,
"message": "Your typeform {{form:title}} has a new response:\n{{form:all_answers}}\n\nTeam Beaconstac\n",
"subject": "Typeform: New response for {{form:title}}",
"recipients": [
"example@mobstac.com"
]
},
"respondent": {
"enabled": true,
"message": "Hello,\nWe’ve received your submission.\n{{form:all_answers}}\nThank you & have a nice day!",
"subject": "Typeform: Thank you for filling out {{form:title}}",
"recipient": "{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}"
}
},
"show_progress_bar": true,
"are_uploads_public": false,
"show_time_to_complete": true,
"show_typeform_branding": false
},
"variables": {
"score": 0
},
"workspace": {
"href": "https://api.typeform.com/workspaces/11932656"
},
"welcome_screens": [
{
"id": "fj9xH9ygOieI",
"ref": "c4474bbc-156f-4e1d-b585-057bd0461eaf",
"title": "We are dedicated to prevent the spread of the novel coronavirus.\n\nFill in the form to get access & enjoy a risk-free time inside!",
"attachment": {
"href": "https://images.typeform.com/images/d32SKu3vqLBg",
"type": "image"
},
"properties": {
"button_text": "GET STARTED",
"show_button": true
}
}
],
"thankyou_screens": [
{
"id": "LIe8AepMKkEW",
"ref": "8778f1ad-dfed-4e46-8c82-7c537acfcb63",
"title": "Present this screen at the entrance to get access",
"attachment": {
"href": "https://images.typeform.com/images/XEgYmdcrYX3p",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "YJ9uZJcxDxum",
"ref": "f4b1a41d-c28a-4b8c-941b-a681f4c25e2b",
"title": "Based on your answers, we have a few additional queries, please speak with our representative",
"attachment": {
"href": "https://images.typeform.com/images/pT3fchZA2qfi",
"type": "image"
},
"properties": {
"button_mode": "reload",
"button_text": "again",
"share_icons": false,
"show_button": true
}
},
{
"id": "DefaultTyScreen",
"ref": "default_tys",
"title": "Done! Your information was sent perfectly.",
"properties": {
"share_icons": false,
"show_button": false
}
}
]
},
"default": false,
"title": "Test Form",
"url": "https://eddypro.typeform.com/to/jLMqrBWb",
"form_id": "jLMqrBWb",
"form_type": "TY",
"sms_structure": {},
"email_structure": {},
"meta": {
"creator_id": 15189,
"updater_id": 15189,
"creator_email": "example@mobstac.com",
"updater_email": "example@mobstac.com"
},
"created": "2020-11-06T16:45:21.449705+05:30",
"updated": "2020-11-06T16:45:21.457306+05:30",
"organization": 15406,
"maintainer": 15189,
"beacons": [],
"form_response_count": 0
}
Updates the specified Feedback Form by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the Landing Page object.
Get Form responses
curl --location --request GET 'https://api.beaconstac.com/api/2.0/forms/{form_id}/responses/?page_size={responses_per_page}&since={start_timestamp}&until={end_timestamp}&timezone={timezone}&organization={organization_id}' \
--header 'Authorization: Token YOUR_TOKEN'
The above command returns JSON structured like this:
{
"count": 3,
"previous": null,
"next": "https://api.beaconstac.com/api/2.0/forms/54024/responses/?page_size=2&since=1587468650975&until=1604687400000&timezone=Asia%2FKolkata&organization=15406&before=5h7knpm1q0dqd5h70p1k2w7x274jil0b",
"results": [
{
"landing_id": "t7dbyzr0sinwnkqm35sxt7degyy1ka7r",
"token": "t7dbyzr0sinwnkqm35sxt7degyy1ka7r",
"response_id": "t7dbyzr0sinwnkqm35sxt7degyy1ka7r",
"landed_at": "2020-11-06T11:41:55Z",
"submitted_at": "2020-11-06T11:42:46Z",
"metadata": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:82.0) Gecko/20100101 Firefox/82.0",
"platform": "other",
"referer": "https://eddypro.typeform.com/to/jLMqrBWb?typeform-embed=embed-fullpage",
"network_id": "61c96e4853",
"browser": "default"
},
"hidden": {},
"calculated": {
"score": 0
},
"answers": [
{
"field": {
"id": "I7nuPFZhjE1K",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email"
},
"type": "email",
"email": "qwerty@mobstac.com"
},
{
"field": {
"id": "hJseJYIAeZEI",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number"
},
"type": "phone_number",
"phone_number": "+919876543210"
},
{
"field": {
"id": "dTLRFH28YFK2",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text"
},
"type": "text",
"text": "Qwerty"
},
{
"field": {
"id": "EbrryKpXStuY",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "hpka5skZ1nIr",
"label": "No"
}
},
{
"field": {
"id": "KH9u7f7VFoTV",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "TMEsbKqUfsak",
"label": "Female"
}
},
{
"field": {
"id": "OqjVKoTyVFDu",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "cax9N9NoPPuw",
"label": "None of the above"
}
},
{
"field": {
"id": "ETpJlnONBDGJ",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "YcK1JVDjXohR",
"label": "No"
}
},
{
"field": {
"id": "GZykpXs0OZ5P",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "2FUSodzYL2A5",
"label": "No"
}
}
],
"variables": [
{
"key": "score",
"type": "number",
"number": 0
}
]
},
{
"landing_id": "5h7knpm1q0dqd5h70p1k2w7x274jil0b",
"token": "5h7knpm1q0dqd5h70p1k2w7x274jil0b",
"response_id": "5h7knpm1q0dqd5h70p1k2w7x274jil0b",
"landed_at": "2020-11-06T11:40:22Z",
"submitted_at": "2020-11-06T11:41:47Z",
"metadata": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:82.0) Gecko/20100101 Firefox/82.0",
"platform": "other",
"referer": "https://eddypro.typeform.com/to/jLMqrBWb?typeform-embed=embed-fullpage",
"network_id": "61c96e4853",
"browser": "default"
},
"hidden": {},
"calculated": {
"score": 2
},
"answers": [
{
"field": {
"id": "I7nuPFZhjE1K",
"ref": "bb5aa51c-e8d4-4f47-8371-3856c6dea423",
"type": "email"
},
"type": "email",
"email": "test@beaconstac.com"
},
{
"field": {
"id": "hJseJYIAeZEI",
"ref": "ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a",
"type": "phone_number"
},
"type": "phone_number",
"phone_number": "+914321567890"
},
{
"field": {
"id": "dTLRFH28YFK2",
"ref": "094fd986-95bf-4ff5-9a42-4ad25145fe11",
"type": "short_text"
},
"type": "text",
"text": "Test"
},
{
"field": {
"id": "EbrryKpXStuY",
"ref": "5e18502f-3a4e-4894-9f03-dce6d78e0bb5",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "hpka5skZ1nIr",
"label": "No"
}
},
{
"field": {
"id": "KH9u7f7VFoTV",
"ref": "b99521ba-9e6f-4357-8ed5-acf6740833d7",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "TMEsbKqUfsak",
"label": "Female"
}
},
{
"field": {
"id": "OqjVKoTyVFDu",
"ref": "5a0f2b02-2302-4029-bfaf-ddb3d9446713",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "WhzCOEpomwRb",
"label": "Cold and cough"
}
},
{
"field": {
"id": "ETpJlnONBDGJ",
"ref": "ce43e9ac-2e20-4318-9a45-e2143f29c13b",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "5Rn7zBmmPNHd",
"label": "Yes"
}
},
{
"field": {
"id": "GZykpXs0OZ5P",
"ref": "083443e3-69e4-4bd8-a84a-05e6d14dabed",
"type": "multiple_choice"
},
"type": "choice",
"choice": {
"id": "nb2bUDb9uTvz",
"label": "Not sure"
}
}
],
"variables": [
{
"key": "score",
"type": "number",
"number": 2
}
]
}
]
}
App Links
Redirects users to appropriate URLs (App Store / Play Store) based on the Operating System of the device being used.
| Attributes |
|---|
android_url URL URL (Google Play Store) for Android users to be redirected to |
iphone_url URL URL (App Store) for iOS users to be redirected to |
ipad_url URL URL (App Store) for iPad or Mac users to be redirected to (redirected to iphone_url if not present) |
fallback_url URL required General URL to be redirected to if device does not satisfy above conditions |
vCard Plus
Create vCards to allow anyone to view your contact information and add it to their device instantly.
| Attributes |
|---|
first_name string required First name of the recipient |
last_name string required Last name of the recipient |
user_image_url URL URL for profile picture of the recipient |
company string Name of the company the recipient works for |
designation string Designation held by the recipient |
summary string Brief summary to be displayed on the page |
phone object Phone numbers associated with the recipient. Supported keys: |
email string Recipient email address |
website URL Company/Recipient website URL |
logo_url URL Company/Recipient logo image |
address_url URL Recipient address from Google or Apple maps |
address_line1 string Recipient address line 1 to be displayed |
address_line2 string Recipient address line 1 to be displayed |
city string Recipient city of residence |
zip string Recipient area zip code |
state string Recipient state of residence |
country string Recipient country of residence |
customizations object Landing page customizations |
customization options (supports hex and rgb color formats): background_color, user_info_color
Social Media
Create a landing page to engage with your users through various social media platforms
| Attributes |
|---|
title string required First name of the recipient |
urls object required Supports |
logo_url URL Logo URL associated with your brand |
brand_image URL Image URL associated with your brand |
message string Short display message |
sub_text string Sub text for the message |
customizations object Landing page customizations |
customization options (supports hex and rgb color formats): title_color, message_background_color
Facebook page
Create a landing page link your facebook page to grow followers and increase likes
| Attributes |
|---|
facebook_page_url URL required URL associated with your Facebook page |
like_button_type string Type of like button () |
logo_url URL Logo URL associated with your brand |
header string Header message for the page |
sub_text string Sub text for the header |
base_image URL Base image URL for the page |
Coupon
Create coupon codes campaigns that can be redeemed by users engaging with your business
| Attributes |
|---|
coupon_code string required Coupon Code |
expires_at timestamp requiredExpiry date for coupon in ISO format |
timezone timestampExpiry date for coupon in ISO format |
header string requiredHeader message for the landing page |
message string requiredDisplay message for the page |
logo_url URL Logo URL associated with your brand |
website URL Your brand website |
description_header string Header describing the coupon |
description_body string A brief description for the coupon |
terms_and_conditions string Terms and Conditions associated with this coupon |
wallet_pass object Wallet pass customizations |
location URL URL to locate your business |
company_name string Company name |
custom_theme integer Custom Theme object ID |
theme_data object read only Custom Theme data |
customizations object Landing page customizations |
| Wallet pass options (shown on iOS devices only) |
|---|
barcode_format string Type of barcode to be displaayed (options: |
customization options (supports hex and rgb color formats): header_color, body_color, background_color, coupon_color, button_color
Business Card
Create a landing page to display your business details that help users connect with you seamlessly.
| Attributes |
|---|
business_name string required Businesss Name |
button_url string required Button Url |
button_title string required Button Title |
contact string required Contact |
logo_url URL Logo URL associated with your business |
aaddress_url URL Address URL for people to locate your business |
website URL Website URL of your business |
headline string A brief headline to summarise your business operaations |
open_hours object Opening and Closing time for the business for each day |
customizations object Landing page customizations |
| Contact options |
|---|
name string required Name of the contact person |
phone string required Phone number |
email string required email ID for viewers to engage with |
customization options (supports hex and rgb color formats): background_color, opacity, button_color
Campaign Notification
Campaign notification is the brief overview of the campaign, used to alert the user. This can only be used with Beacon and Geofence objects.
| Attributes |
|---|
id integer read only Unique identifier of the object |
language_code string required ISO 639-1 language code. Each beacon can have only 1 language notification. |
is_default boolean required Is default notification. Each beacon can have only one notification set as default. |
title string The title of the campaign notification (max 49 characters) |
description string The description of the campaign notification (max 2048 characters) |
icon_url URL The icon url of the campaign notification |
created timestamp read only Created timestamp of the campaign notification |
updated timestamp read only Last updated timestamp of the campaign notification |
Beacon
Beacon objects allow you to perform actions on your beacons. You can retrieve individual beacons as well as a list of all your beacons or update a beacon.
| Attributes |
|---|
id integer read only Unique identifier of the object |
name string required The name of the beacon |
UUID string required read only UUID of the beacon associated with the iBeacon protocol, configured on the hardware |
major integer required read only Major value of the beacon associated with the iBeacon protocol, configured on the hardware |
minor integer required read only Minor value of the beacon associated with the iBeacon protocol, configured on the hardware |
organization integer required read only Id of the organization to which the beacon belongs to |
place integer required read only Id of the place where the beacon is deployed |
serial_number string read only Serial number of the hardware |
eddystone_nid string read only Namespace of the beacon associated with the Eddystone protocol, configured on the hardware |
eddystone_bid string read only Instance of the beacon associated with the Eddystone protocol, configured on the hardware |
eddystone_url string read only URL(Deprecated) configured on the hardware |
url string read only URL configured on the hardware |
state string read only State of the beacon ( |
place_data list[object] read only Place data associated with place id. |
tags list[integer] List of associated tag ids |
tag_data list[object] Tag data associated with attached tag ids. |
rules list[integer] List of associated rule ids |
rule_data list[object] Rule data associated with attached rule ids |
mode string read only Mode of the beacon |
tx_power integer Transmission power configured on the hardware |
advertising_interval integer Advertising interval configured on the hardware |
battery integer Battery reported by the hardware |
temperature integer Temperature, reported by the hardware |
latitude float Latitude |
longitude float Longitude |
closeby_id integer read only Closeby ID of the beacon(Deprecated) |
nearby_id string Proximity ID of the beacon |
proximity_status string read only Proximity status (Deprecated) |
meta object Metadata associated with the beacon |
deployment_meta object Deployment meta associated with the beacon |
kit_type object read only Beacon kit type (Deprecated) |
created timestamp read only Created timestamp of the beacon |
updated timestamp read only Last updated timestamp of the beacon |
heartbeat timestamp read only Timestamp when the beacon was last detected |
campaign Campaign |
notifications list[CampaignNotification] |
Get all beacons
curl "https://api.beaconstac.com/api/2.0/beacons/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 8072,
"meta": {
"hardware_type": 1
},
"deployment_meta": {},
"kit_type": {
"types": [
"AK",
"SK"
]
},
"place_data": {
"id": 8361,
"name": "KIA Bengaluru"
},
"tag_data": [],
"campaign": {
"id": 3335,
"name": "Ola - Scooter taxi",
"custom_url": "https://www.tiny.cc/gmymry",
"content_type": 2,
"campaign_active": true,
"created": "2017-09-01T05:22:20.318082Z",
"updated": "2019-05-28T08:43:13.826580Z",
"organization": 1697,
"markdown_card": 9572,
"form": 12406,
"schedule": 28
},
"proximity_status": 0,
"eddystone_url": "https://eddy.pro/vLkeTm",
"name": "0117C5978008",
"url": "https://eddy.pro/vLkeTm",
"state": "A",
"heartbeat": "2019-06-24T06:19:24.245871Z",
"created": "2017-09-01T05:22:19.967161Z",
"updated": "2019-06-24T06:19:24.246013Z",
"UUID": "F94DBB23-2266-7822-3782-57BEAC0952AC",
"major": 58460,
"minor": 21851,
"latitude": 12.9818683,
"longitude": 77.6404922,
"temperature": 19,
"battery": 99,
"advertising_interval": 211,
"tx_power": 4,
"mode": "IL",
"serial_number": "0117C5978008",
"eddystone_nid": "5DC33487F02E477D4058",
"eddystone_bid": "0117C5978008",
"closeby_id": 731031,
"nearby_id": "beacons/3!5dc33487f02e477d40580117c5978008",
"organization": 1697,
"place": 8361,
"tags": []
},
{
"id": 20017,
"meta": {
"hardware_type": 4
},
"deployment_meta": {},
"kit_type": {
"types": [
"AK",
"SK"
]
},
"place_data": {
"id": 2888,
"name": "Times Square"
},
"tag_data": [
{
"id": 1076,
"name": "Footwear"
}
],
"campaign": {
"id": 14395,
"name": "Vipin Schedule Test",
"custom_url": "https://www.google.com",
"content_type": 4,
"campaign_active": true,
"created": "2018-09-17T07:29:28.674926Z",
"updated": "2019-04-18T09:49:37.916926Z",
"organization": 1697,
"markdown_card": 10790,
"form": 11805,
"schedule": 4586
},
"proximity_status": 0,
"eddystone_url": "https://eddy.pro/uREvlU",
"name": "AC233F25A31B",
"url": "https://eddy.pro/uREvlU",
"state": "A",
"heartbeat": "2019-06-24T06:11:59.475411Z",
"created": "2018-09-17T07:29:28.649751Z",
"updated": "2019-06-24T06:11:59.475541Z",
"UUID": "F94DBB23-2266-7822-3782-57BEAC0952AC",
"major": 46468,
"minor": 13497,
"latitude": 40.758895,
"longitude": -73.985131,
"temperature": 22,
"battery": 100,
"advertising_interval": 200,
"tx_power": -8,
"mode": "IL",
"serial_number": "AC233F25A31B",
"eddystone_nid": "5DC33487F02E477D4058",
"eddystone_bid": "AC233F25A31B",
"closeby_id": 16278664,
"nearby_id": "beacons/3!5dc33487f02e477d4058ac233f25a31b",
"organization": 1697,
"place": 2888,
"tags": [
1076
]
}
]
}
Returns a list of your beacons. The beacons are returned sorted by beacon heartbeat, with the most recent detected beacons appearing first.
Filter arguments:
name:exact,icontainsserial_number:exact,icontainsplace__name:exact,icontainstags__name:exact,icontainsurl:exactheartbeat:lt,lte,gt,gtecampaign__content_type:exactstate:exact
Search Fields:
nameserial_numberplace__nametags__nameurlcampaign__content_type
Ordering fields:
nameserial_numberbatteryheartbeat: defaultplace__namecreatedupdatedcampaign__content_typestate
Retrieve a beacon
curl "https://api.beaconstac.com/api/2.0/beacons/{beacon_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 15646,
"meta": {
"hardware_type": 3
},
"place_data": {
"id": 7466,
"name": "Times Square"
},
"tag_data": [],
"campaign": {
"id": 10130,
"name": "Half Price, Happy Hour",
"custom_url": "https://www.google.com",
"content_type": 2,
"campaign_active": true,
"created": "2018-06-01T10:47:21.785384Z",
"updated": "2019-06-05T20:39:35.266185Z",
"organization": 3935,
"markdown_card": 11653,
"form": 12422,
"schedule": 4399
},
"deployment_meta": {},
"kit_type": {
"types": [
"AK",
"SK"
]
},
"rules": [],
"rule_data": [],
"notifications": [
{
"id": 1323950,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "轉數快：隨時隨地，跨行即時過數！",
"description": null,
"icon_url": "https://d1bqobzsowu5wu.cloudfront.net/3568/a7fbe7d8f0d84595ac0dfa75c31f9a08",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": false,
"slug": "轉數快隨時隨地跨行即時過數",
"created": "2018-09-17T10:15:33.082052Z",
"updated": "2019-05-02T11:48:55.626906Z",
"language_code": "en"
},
{
"id": 1383027,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "轉數快：隨時隨地，跨行即時過數！",
"description": "",
"icon_url": "https://d1bqobzsowu5wu.cloudfront.net/3568/a7fbe7d8f0d84595ac0dfa75c31f9a08",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "轉數快隨時隨地跨行即時過數",
"created": "2018-10-30T08:12:21.938128Z",
"updated": "2019-05-02T11:48:55.640839Z",
"language_code": "zh"
}
],
"proximity_status": 0,
"eddystone_url": "https://eddy.pro/CKEc5X",
"name": "The Coffeeshop",
"url": "https://eddy.pro/CKEc5X",
"state": "A",
"heartbeat": "2018-09-17T10:15:59.184415Z",
"created": "2018-06-01T10:47:21.744035Z",
"updated": "2019-06-05T20:39:35.299706Z",
"UUID": "F94DBB23-2266-7822-3782-57BEAC0952AC",
"major": 54222,
"minor": 60051,
"latitude": null,
"longitude": null,
"temperature": 0,
"battery": 0,
"advertising_interval": 200,
"tx_power": -8,
"mode": "IL",
"serial_number": "AC233F251546",
"eddystone_nid": "5DC33487F02E477D4058",
"eddystone_bid": "AC233F251546",
"closeby_id": 11348073,
"nearby_id": "beacons/3!5dc33487f02e477d4058ac233f251546",
"organization": 3935,
"place": 7466,
"tags": []
}
Retrieves the details of an existing beacon. You need only supply the unique beacon identifier that was returned upon beacon listing
Update Beacon
curl "https://api.beaconstac.com/api/2.0/beacons/{beacon_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':beacon_id, 'campaign':{'id':campaign_id}}"
The above command returns JSON structured like this:
{
"id": 15646,
"meta": {
"hardware_type": 3
},
"place_data": {
"id": 7466,
"name": "Times Square"
},
"tag_data": [],
"campaign": {
"id": 10130,
"name": "Customer satisfaction survey",
"custom_url": "https://www.google.com",
"content_type": 3,
"campaign_active": true,
"created": "2018-06-01T10:47:21.785384Z",
"updated": "2019-06-24T08:47:29.158541Z",
"organization": 3935,
"markdown_card": 11653,
"form": 12422,
"schedule": 4399
},
"deployment_meta": {},
"kit_type": {
"types": [
"AK",
"SK"
]
},
"rules": [],
"rule_data": [],
"notifications": [
{
"id": 1323950,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "轉數快：隨時隨地，跨行即時過數！",
"description": "轉數快：隨時隨地",
"icon_url": "https://d1bqobzsowu5wu.cloudfront.net/3568/a7fbe7d8f0d84595ac0dfa75c31f9a08",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": false,
"slug": "轉數快隨時隨地跨行即時過數",
"created": "2018-09-17T10:15:33.082052Z",
"updated": "2019-06-24T08:47:29.139565Z",
"language_code": "en"
},
{
"id": 1383027,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "轉數快：隨時隨地，跨行即時過數！",
"description": "",
"icon_url": "https://d1bqobzsowu5wu.cloudfront.net/3568/a7fbe7d8f0d84595ac0dfa75c31f9a08",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "轉數快隨時隨地跨行即時過數",
"created": "2018-10-30T08:12:21.938128Z",
"updated": "2019-06-24T08:47:29.152753Z",
"language_code": "zh"
}
],
"proximity_status": 0,
"eddystone_url": "https://eddy.pro/CKEc5X",
"name": "The Coffeeshop",
"url": "https://eddy.pro/CKEc5X",
"state": "A",
"heartbeat": "2018-09-17T10:15:59.184415Z",
"created": "2018-06-01T10:47:21.744035Z",
"updated": "2019-06-24T08:47:29.095082Z",
"UUID": "F94DBB23-2266-7822-3782-57BEAC0952AC",
"major": 54222,
"minor": 60051,
"latitude": null,
"longitude": null,
"temperature": 0,
"battery": 0,
"advertising_interval": 200,
"tx_power": -8,
"mode": "IL",
"serial_number": "AC233F251546",
"eddystone_nid": "5DC33487F02E477D4058",
"eddystone_bid": "AC233F251546",
"closeby_id": 11348073,
"nearby_id": "beacons/3!5dc33487f02e477d4058ac233f251546",
"organization": 3935,
"place": 7466,
"tags": []
}
Updates the specified beacon by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the Beacon object.
NFC Tag
NFCTag objects allow you to perform actions on your nfc tags. You can retrieve individual nfc tags as well as a list of all your tags or update a tag.
| Attributes |
|---|
id integer read only Unique identifier of the NFC tag |
name string required The name of the nfc tag |
uid string required read only UID of the hardware |
counter integer read only NFC tag counter. Counts the number of times the hardware tag has been read |
organization integer required read only Id of the organization to which the nfc tag belongs to |
place integer required read only Id of the place where the nfc tag is deployed |
url string read only URL configured on the hardware nfc tag |
state string read only State of the nfc tag ( |
place_data list[object] read only Place data associated with place id. |
tags list[integer] List of associated tag ids |
tag_data list[object] Tag data associated with attached tag ids. |
meta object Metadata associated with the nfc tag |
created timestamp read only Created timestamp of the nfc tag |
updated timestamp read only Last updated timestamp of the nfc tag |
heartbeat timestamp read only Timestamp when the nfc tag was last detected |
campaign Campaign |
Get all NFC tags
curl "https://api.beaconstac.com/api/2.0/nfctags/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 1329,
"name": "04DA184A096180",
"uid": "04DA184A096180",
"counter": 8,
"meta": {
"activationTimestamp": 1552469890
},
"place_data": {
"id": 2888,
"name": "Times Square"
},
"tag_data": [],
"campaign": {
"id": 22398,
"name": "Christmas Special",
"custom_url": "https://www.google.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-03-13T09:38:08.416096Z",
"updated": "2019-03-13T09:38:08.416111Z",
"organization": 1697,
"markdown_card": 1708,
"form": 4377,
"schedule": 28
},
"url": "https://nfc.tapnscan.me/1xdthy",
"state": "A",
"heartbeat": "2019-06-17T11:05:35.788514Z",
"created": "2019-02-26T05:56:07.426902Z",
"updated": "2019-06-17T11:05:35.788643Z",
"encrypted_hardware_key": "o3N6+fKRkCSRaJZJ86xvm6pVEaUmX/+mlfv7RgZfw3bgQdPFE6M0zt4jpx9KiWa0",
"organization": 1697,
"place": 2888,
"tags": []
},
{
"id": 1151,
"name": "046974ca714d81",
"uid": "046974ca714d81",
"counter": 129,
"meta": {
"activationTimestamp": 1552298188
},
"place_data": {
"id": 2888,
"name": "Times Square"
},
"tag_data": [],
"campaign": {
"id": 22295,
"name": "Christmas Special",
"custom_url": "https://www.google.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-03-11T09:56:27.705916Z",
"updated": "2019-03-11T09:56:27.705930Z",
"organization": 1697,
"markdown_card": 1708,
"form": 4377,
"schedule": 28
},
"url": "https://nfc.tapnscan.me/5dkm0C",
"state": "A",
"heartbeat": "2019-06-03T07:12:25.247399Z",
"created": "2019-02-26T05:56:06.109631Z",
"updated": "2019-06-03T07:12:25.247588Z",
"encrypted_hardware_key": "qmK1WNHrq30BGSooKHDmFJoWYNz0CnOXXqdAOWlQ19OHqkL63cagPgsersM+Ma6t",
"organization": 1697,
"place": 2888,
"tags": []
}
]
}
Returns a list of your nfc tags. The tags are returned sorted by updated, with the most recently updated tags appearing first.
Filter arguments:
name:exact,icontainsplace__name:exact,icontainstags__name:exact,icontainsurl:exactcampaign__content_type:exactstate:exact
Search Fields:
nameplace__nametags__nameurlcampaign__content_type
Ordering fields:
nameplace__namecreatedupdated- defaultcampaign__content_typestate
Retrieve a NFC tag
curl "https://api.beaconstac.com/api/2.0/nfctags/{nfctag_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 3,
"name": "04DA184A096180",
"uid": "04DA184A096180",
"counter": 0,
"meta": {
"hardware_type": 8,
"activationTimestamp": 1552891519
},
"place_data": {
"id": 1430,
"name": "MobStac"
},
"tag_data": [],
"campaign": {
"id": 20019,
"name": "Looking for Shoes?",
"custom_url": "https://www.google.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-03-18T06:45:16.989177",
"updated": "2019-03-18T06:45:16.989196",
"organization": 949,
"markdown_card": 135,
"form": 137,
"schedule": 4
},
"url": "https://q.nfc.tapnscan.me/xHfUUg",
"state": "A",
"heartbeat": "2019-06-11T12:12:56.184672Z",
"created": "2019-03-18T06:44:26.671110Z",
"updated": "2019-06-11T12:12:56.184869Z",
"encrypted_hardware_key": "YMjBG8wNhvWCWqJCBJ4Sn7eLPRxrPom91nNuT2cIoog3jr8rIKTnVEOMfFLrviMt",
"organization": 949,
"place": 1430,
"tags": []
}
Retrieves the details of an existing nfc tag. You need only supply the unique nfc tag identifier that was returned upon tags listing.
Update NFC tag
curl "https://api.beaconstac.com/api/2.0/nfctags/{nfctag_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':nfctag_id, 'campaign':{'id':campaign_id}}"
The above command returns JSON structured like this:
{
"id": 1329,
"name": "04DA184A096180",
"uid": "04DA184A096180",
"counter": 8,
"meta": {
"activationTimestamp": 1552469890
},
"place_data": {
"id": 2888,
"name": "Times Square"
},
"tag_data": [],
"campaign": {
"id": 22398,
"name": "Customer Satisfaction Survey",
"custom_url": "https://www.google.com",
"content_type": 3,
"campaign_active": true,
"created": "2019-03-13T09:38:08.416096Z",
"updated": "2019-06-24T09:15:36.134285Z",
"organization": 1697,
"markdown_card": 1708,
"form": 7912,
"schedule": 28
},
"url": "https://nfc.tapnscan.me/1xdthy",
"state": "A",
"heartbeat": "2019-06-17T11:05:35.788514Z",
"created": "2019-02-26T05:56:07.426902Z",
"updated": "2019-06-24T09:15:36.166303Z",
"encrypted_hardware_key": "gl6AECZ4HlF4KgCAFztNxXezG1lAKkeHGL1H8CWopbHVb/vhI4d8mPTxHv+GsTu0",
"organization": 1697,
"place": 2888,
"tags": []
}
Updates the specified nfc tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the NFCTag object.
QR Code
QRCode objects allow you to perform actions on your qr codes. You can retrieve individual qr codes as well as a list of all your qr codes or update a qr code.
| Attributes |
|---|
id integer read only Unique identifier of the QR Code |
name string required The name of the qr code |
fields_data object required Fields data for the QR Code |
attributes object required Attributes data for the QR Code |
qr_type integer QR type ( |
organization integer required read only Id of the organization to which the qr code belongs to |
place integer required read only Id of the place where the qr code is deployed |
url string read only URL configured on the hardware qr code |
state string read only State of the qr code ( |
place_data list[object] read only Place data associated with place id. |
tags list[integer] List of associated tag ids |
tag_data list[object] Tag data associated with attached tag ids. |
meta object Metadata associated with the qr code |
created timestamp read only Created timestamp of the qr code |
updated timestamp read only Last updated timestamp of the qr code |
heartbeat timestamp read only Timestamp when the qr code was last detected |
campaign Campaign |
Get all QR codes
curl "https://api.beaconstac.com/api/2.0/qrcodes/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 224,
"meta": {
"notes": "",
"activationTimestamp": 1557387845
},
"place_data": {
"id": 8361,
"name": "KIA Bengaluru"
},
"tag_data": [],
"campaign": {
"id": 23258,
"name": "Dynamic QR code demo",
"custom_url": "https://www.example.com",
"content_type": 4,
"campaign_active": true,
"created": "2019-05-09T07:44:03.544150Z",
"updated": "2019-05-09T07:44:03.544165Z",
"organization": 1697,
"markdown_card": 13988,
"form": 13620,
"schedule": 4744
},
"fields_data": {},
"attributes": {
"color": "#000000",
"margin": "",
"backgroundImage": "",
"logoImage": ""
},
"url": "https://qr.tapnscan.me/sycwbi",
"name": "Dynamic QR code demo",
"state": "A",
"heartbeat": "2019-06-24T04:42:16.236105Z",
"created": "2019-05-09T07:44:03.517097Z",
"updated": "2019-06-24T04:42:16.236238Z",
"qr_type": 2,
"organization": 1697,
"place": 8361,
"tags": []
},
{
"id": 42,
"meta": {
"notes": "",
"activationTimestamp": 1552334973,
"dynamic_sub_campaign": "landing_page"
},
"place_data": {
"id": 8281,
"name": "San Marco Square"
},
"tag_data": [],
"campaign": {
"id": 22303,
"name": "Half Price, Happy Hour",
"custom_url": "https://google.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-03-11T20:09:31.142375Z",
"updated": "2019-06-20T17:12:54.248951Z",
"organization": 3568,
"markdown_card": 9533,
"form": 11531,
"schedule": 1075
},
"fields_data": {},
"attributes": {
"color": "#000000",
"backgroundImage": "",
"margin": "",
"logoImage": ""
},
"url": "https://qr.tapnscan.me/byonegetonefree",
"name": "Coffee Shop Offer",
"state": "A",
"heartbeat": "2019-06-14T14:48:31.407835Z",
"created": "2019-03-11T20:09:31.126677Z",
"updated": "2019-06-20T17:12:54.272483Z",
"qr_type": 2,
"organization": 3568,
"place": 8281,
"tags": []
}
]
}
Returns a list of your qr codes. The tags are returned sorted by updated, with the most recently updated qr codes appearing first.
Filter arguments:
name:exact,icontainsplace__name:exact,icontainstags__name:exact,icontainsurl:exactcampaign__content_type:exactstate:exact
Search Fields:
nameplace__nametags__nameurlcampaign__content_type
Ordering fields:
nameplace__namecreatedupdated- defaultcampaign__content_typestate
Retrieve a QR code
curl "https://api.beaconstac.com/api/2.0/qrcodes/{qrcode_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 224,
"meta": {
"notes": "",
"activationTimestamp": 1557387845
},
"place_data": {
"id": 8361,
"name": "KIA Bengaluru"
},
"tag_data": [],
"campaign": {
"id": 23258,
"name": "Dynamic QR code demo",
"custom_url": "https://www.example.com",
"content_type": 4,
"campaign_active": true,
"created": "2019-05-09T07:44:03.544150Z",
"updated": "2019-05-09T07:44:03.544165Z",
"organization": 1697,
"markdown_card": 13988,
"form": 13620,
"schedule": 4744
},
"fields_data": {},
"attributes": {
"color": "#000000",
"margin": "",
"backgroundImage": "",
"logoImage": ""
},
"url": "https://qr.tapnscan.me/sycwbi",
"name": "Dynamic QR code demo",
"state": "A",
"heartbeat": "2019-06-24T04:42:16.236105Z",
"created": "2019-05-09T07:44:03.517097Z",
"updated": "2019-06-24T04:42:16.236238Z",
"qr_type": 2,
"organization": 1697,
"place": 8361,
"tags": []
}
Retrieves the details of an existing qr code. You need only supply the unique qr code identifier that was returned upon qr codes listing.
Update QR code
Dynamic QR Code
curl "https://api.beaconstac.com/api/2.0/qrcodes/{qrcode_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':qrcode_id, 'campaign':{'id':campaign_id}}"
The above command returns JSON structured like this:
{
"id": 224,
"meta": {
"notes": "",
"activationTimestamp": 1557387845,
"dynamic_sub_campaign": "feedback_form"
},
"place_data": {
"id": 8361,
"name": "KIA Bengaluru"
},
"tag_data": [],
"campaign": {
"id": 23258,
"name": "Customer Satisfaction Survey",
"custom_url": "https://www.example.com",
"content_type": 3,
"campaign_active": true,
"created": "2019-05-09T07:44:03.544150Z",
"updated": "2019-06-24T09:41:59.015809Z",
"organization": 1697,
"markdown_card": 13988,
"form": 7912,
"schedule": 4744
},
"fields_data": {},
"attributes": {
"color": "#000000",
"backgroundImage": "",
"margin": "",
"logoImage": ""
},
"url": "https://qr.tapnscan.me/sycwbi",
"name": "Dynamic QR code demo",
"state": "A",
"heartbeat": "2019-06-24T04:42:16.236105Z",
"created": "2019-05-09T07:44:03.517097Z",
"updated": "2019-06-24T09:41:59.045695Z",
"qr_type": 2,
"organization": 1697,
"place": 8361,
"tags": []
}
Updates the specified qr code by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the QRCode object.
Create QR code
curl -X POST \ https://api.beaconstac.com/api/2.0/qrcodes/ \ -H 'Content-Type: application/json' \ -d '{ "attributes": { "color": "#000000", "margin": "", "backgroundImage": "", "logoImage": "" }, "name": "test 3", "qr_type": 2, "organization": {organization_id}, "place": {place_id} }'
The above command returns JSON structured like this:
{
"id": 224,
"meta": {
"notes": "",
"activationTimestamp": 1557387845,
"dynamic_sub_campaign": "feedback_form"
},
"place_data": {
"id": 8361,
"name": "KIA Bengaluru"
},
"tag_data": [],
"campaign": {
"id": 23258,
"name": "Customer Satisfaction Survey",
"custom_url": "https://www.example.com",
"content_type": 3,
"campaign_active": true,
"created": "2019-05-09T07:44:03.544150Z",
"updated": "2019-06-24T09:41:59.015809Z",
"organization": 1697,
"markdown_card": 13988,
"form": 7912,
"schedule": 4744
},
"fields_data": {},
"attributes": {
"color": "#000000",
"backgroundImage": "",
"margin": "",
"logoImage": ""
},
"url": "https://qr.tapnscan.me/sycwbi",
"name": "test 3",
"state": "A",
"heartbeat": "2019-06-24T04:42:16.236105Z",
"created": "2019-05-09T07:44:03.517097Z",
"updated": "2019-06-24T09:41:59.045695Z",
"qr_type": 2,
"organization": 1697,
"place": 8361,
"tags": []
}
Creates a new qr code. However, the request should contain the required fields.
Download a QR code
curl "https://api.beaconstac.com/api/2.0/qrcodes/{qrcode_id}/?size={size}&canvas_type={canvas_type}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"urls": {
"svg": "https://beaconstac-content.s3.amazonaws.com/1697/qr-codes/224/svg/aHR0cHM6Ly9xci50YXBuc2Nhbi5tZS9zeWN3Ymk%3D-1024.svg"
}
}
Download a QR code in a particular size and image format. Image types supported are PNG, JPEG, SVG and PDF. If no canvas type is sent in the parameters, the QRCode would be generated in all image types supported.
Geofence
Geofence objects allow you to perform actions on your geofences. You can retrieve individual geofences as well as a list of all your geofences or update a geofence
| Attributes |
|---|
id integer read only Unique identifier of the Geofence |
name string required The name of the geofence |
latitude float required Latitude of the geofence |
longitude float required Longitude of the geofence |
radius float required Radius of the geofence |
organization integer required read only Id of the organization to which the geofence belongs to |
place integer required Id of the place where the geofence is configured |
url string read only URL configured for the geofence |
state string read only State of the geofence ( |
place_data list[object] read only Place data associated with place id. |
tags list[integer] List of associated tag ids |
tag_data list[object] read only Tag data associated with attached tag ids. |
meta object Metadata associated with the geofence |
created timestamp read only Created timestamp of the geofence |
updated timestamp read only Last updated timestamp of the geofence |
heartbeat timestamp read only Timestamp when the goefence was last detected |
campaign Campaign |
notifications list[CampaignNotification] |
Get all geofences
curl "https://api.beaconstac.com/api/2.0/geofences/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 5,
"meta": {
"notes": ""
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"campaign": {
"id": 20144,
"name": "Looking for Shoes?",
"custom_url": "https://www.example.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-06-09T06:03:10.894882",
"updated": "2019-06-13T07:06:23.806157",
"organization": 949,
"markdown_card": 135,
"form": 137,
"schedule": 4
},
"url": "https://geo.tapnscan.me/b6Pt2C",
"notifications": [
{
"id": 451,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "Ola Prime welcomes you to Bengaluru 8",
"description": "Enjoy your favourite music on the way home",
"icon_url": "https://s3.amazonaws.com/beaconstac-content-qa/949/22a9aefb67034f1998551b97f34d6c4b",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "ola-prime-welcomes-you-to-bengaluru-8",
"created": "2019-06-12T11:03:10.908622Z",
"updated": "2019-06-13T07:06:23.801249Z",
"language_code": "en"
}
],
"name": "Test",
"state": "A",
"heartbeat": "2019-06-18T06:57:38.752214Z",
"created": "2019-06-12T11:03:10.878086Z",
"updated": "2019-06-18T06:57:38.752444Z",
"latitude": "12.981900",
"longitude": "77.640500",
"radius": 1001,
"organization": 949,
"place": 1258,
"tags": []
},
{
"id": 7,
"meta": {
"notes": ""
},
"place_data": {
"id": 1504,
"name": "India"
},
"tag_data": [],
"campaign": {
"id": 20146,
"name": "Looking for Shoes?",
"custom_url": "https://www.example.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-06-17T06:48:36.820377",
"updated": "2019-06-17T06:48:36.820395",
"organization": 949,
"markdown_card": 135,
"form": 1111,
"schedule": 28
},
"url": "https://geo.tapnscan.me/Cie705",
"notifications": [
{
"id": 453,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "Decorate your foot!!!",
"description": "The best shoe you will ever find in this universe",
"icon_url": "https://s3.amazonaws.com/beaconstac-content-qa/949/d15803855cf14f468d52613666767a33",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "decorate-your-foot",
"created": "2019-06-17T06:48:36.836419Z",
"updated": "2019-06-17T06:48:36.836439Z",
"language_code": "en"
}
],
"name": "My Loc",
"state": "A",
"heartbeat": "2019-06-18T06:57:38.750112Z",
"created": "2019-06-17T06:48:36.809354Z",
"updated": "2019-06-18T06:57:38.750294Z",
"latitude": "12.981900",
"longitude": "77.640500",
"radius": 500,
"organization": 949,
"place": 1504,
"tags": []
}
]
}
Filter arguments:
name:exact,icontainsplace__name:exact,icontainstags__name:exact,icontainsurl:exactcampaign__content_type:exactstate:exact
Search Fields:
nameplace__nametags__nameurlcampaign__content_type
Ordering fields:
nameplace__namecreatedupdated- defaultcampaign__content_typestate
Returns a list of your geofences. The geofences are returned sorted by updated, with the most recently updated geofence appearing first.
Retrieve a Geofence
curl "https://api.beaconstac.com/api/2.0/geofences/{geofence_id}"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"id": 5,
"meta": {
"notes": ""
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"campaign": {
"id": 20144,
"name": "Looking for Shoes?",
"custom_url": "https://www.example.com",
"content_type": 2,
"campaign_active": true,
"created": "2019-06-09T06:03:10.894882",
"updated": "2019-06-13T07:06:23.806157",
"organization": 949,
"markdown_card": 135,
"form": 137,
"schedule": 4
},
"url": "https://geo.tapnscan.me/b6Pt2C",
"notifications": [
{
"id": 451,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "Ola Prime welcomes you to Bengaluru 8",
"description": "Enjoy your favourite music on the way home",
"icon_url": "https://s3.amazonaws.com/beaconstac-content-qa/949/22a9aefb67034f1998551b97f34d6c4b",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "ola-prime-welcomes-you-to-bengaluru-8",
"created": "2019-06-12T11:03:10.908622Z",
"updated": "2019-06-13T07:06:23.801249Z",
"language_code": "en"
}
],
"name": "Test",
"state": "A",
"heartbeat": "2019-06-18T06:57:38.752214Z",
"created": "2019-06-12T11:03:10.878086Z",
"updated": "2019-06-18T06:57:38.752444Z",
"latitude": "12.981900",
"longitude": "77.640500",
"radius": 1001,
"organization": 949,
"place": 1258,
"tags": []
}
Retrieves the details of an existing geofence. You need only supply the unique geofence identifier that was returned upon geofence listing.
Update Geofence
curl "https://api.beaconstac.com/api/2.0/geofences/{geofence_id}"
-X PUT
-H "Authorization: Token YOUR_TOKEN"
-d "{'id':geofence_id, 'campaign':{'id':campaign_id}}"
The above command returns JSON structured like this:
{
"id": 5,
"meta": {
"notes": ""
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"campaign": {
"id": 20144,
"name": "Customer Satisfaction Survey",
"custom_url": "https://www.example.com",
"content_type": 3,
"campaign_active": true,
"created": "2019-06-09T06:03:10.894882",
"updated": "2019-06-24T09:28:08.905138Z",
"organization": 949,
"markdown_card": 135,
"form": 137,
"schedule": 4
},
"url": "https://geo.tapnscan.me/b6Pt2C",
"notifications": [
{
"id": 451,
"meta": {
"closeby": {},
"nearby": {}
},
"title": "Ola Prime welcomes you to Bengaluru 8",
"description": "Enjoy your favourite music on the way home",
"icon_url": "https://s3.amazonaws.com/beaconstac-content-qa/949/22a9aefb67034f1998551b97f34d6c4b",
"banner_type": 1,
"banner_image_url": null,
"app_intent": null,
"is_default": true,
"slug": "ola-prime-welcomes-you-to-bengaluru-8",
"created": "2019-06-12T11:03:10.908622Z",
"updated": "2019-06-24T09:28:08.901039Z",
"language_code": "en"
}
],
"name": "Test",
"state": "A",
"heartbeat": "2019-06-18T06:57:38.752214Z",
"created": "2019-06-12T11:03:10.878086Z",
"updated": "2019-06-24T09:28:08.930559Z",
"latitude": "12.981900",
"longitude": "77.640500",
"radius": 1001,
"organization": 949,
"place": 1258,
"tags": []
}
Updates the specified geofence by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields. Please refer to the Geofence object.
Create Geofence
curl -X POST \
https://api.beaconstac.com/api/2.0/geofences/ \
-H 'Content-Type: application/json' \
-d '{
"campaign": {
"id": 223,
"custom_url": "https://beaconstac.com",
"content_type": 2,
"campaign_active": true,
"organization": 1284,
"markdown_card": 434,
"form": 7099,
"schedule": null
},
"name": "Corner",
"place": 1929,
"latitude": 12.21343,
"longitude": 12.213132,
"radius": 100,
"organization": 1234
}'
The above command returns JSON structured like this:
{
"id": 4
"campaign": {
"id": 223,
"custom_url": "https://beaconstac.com",
"content_type": 2,
"campaign_active": true,
"organization": 1284,
"markdown_card": 434,
"form": 7099,
"schedule": null
},
"name": "Corner",
"place": 1929,
"latitude": 12.21343,
"longitude": 12.213132,
"radius": 100,
"organization": 1234
}
You can create the geofence by giving it a name, latitude, longitude, radius and a campaign.
Place
Place objects allow you to view all places in your account and view beacons attached to them.
| Attributes |
|---|
id integer read only Unique identifier of the Place |
name string required The name of the place |
latitude float required Latitude of the place |
longitude float required Longitude of the place |
organization integer required read only Id of the organization to which the place belongs to |
place_id integer required Google Place ID of the place |
address string Google Place Address of the place |
beacons list[object] read only Beacon data associated with place id. |
beacon_count integer read only Number of beacons associated with the place |
default_place boolean read only Indicated whether the place is a default place |
business_icon_url string Business Icon URL (Used in NearBee) |
business_cover_url string Business Cover URL (Used in NearBee) |
business_color string Business Color (Used in NearBee) |
created timestamp read only Created timestamp of the place |
updated timestamp read only Last updated timestamp of the place |
Get all places
curl "https://api.beaconstac.com/api/2.0/places/"
-H "Authorization: Token YOUR_TOKEN"
The above command returns JSON structured like this:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 8361,
"beacons": [
{
"id": 8072,
"name": "0117C5978008",
"heartbeat": "2019-06-24T09:57:05.970926Z",
"state": "A"
}
],
"beacon_count": 1,
"default_place": null,
"name": "KIA Bengaluru",
"latitude": 13.1986348,
"longitude": 77.7065928,
"place_id": "ChIJZWJEdf4crjsRjkEpoelwbCk",
"address": "Kempegowda International Airport Bengaluru,KIAL Rd, Devanahalli, Bengaluru, Karnataka 560300, India",
"business_icon_url": "https://d1bqobzsowu5wu.cloudfront.net/1697/e5356e8bde3c4afc92e48d64c898e721",
"business_cover_url": "https://d1bqobzsowu5wu.cloudfront.net/1697/9cffaa07236e4ccea144fd4ee0f17804",
"business_color": "145eb0",
"created": "2019-04-08T13:51:35.963177Z",
"updated": "2019-05-02T09:34:48.149451Z",
"organization": 1697
},
{
"id": 5511,
"beacons": [],
"beacon_count": 0,
"default_place": null,
"name": "Central Park",
"latitude": 40.7828647,
"longitude": -73.9653551,
"place_id": "ChIJ4zGFAZpYwokRGUGph3Mf37k",
"address": "Central Park,New York, NY, USA",
"business_icon_url": null,
"business_cover_url": null,
"business_color": null,
"created": "2018-06-05T07:22:49.722062Z",
"updated": "2018-06-05T07:22:49.722086Z",
"organization": 1697
}
]
}
Returns a list of your places.
Filter arguments:
name:exact,icontains
Search Fields:
name
Ordering fields:
namecreatedupdated- defaultaddress
Analytics
Product
Product types:
- beacon
- nfc
- qr
- geofence
from, to parameters should be in EPOCH milliseconds.
Product overview
curl "https://api.beaconstac.com/reporting/2.0/?organization={organization_id}&method=Products.getOverview"
-H "Authorization: Token YOUR_TOKEN"
-d '{
"product_type": {type},
"from": 1560796200000,
"to": 1561401000000
}'
The above command returns JSON structured like this:
{
"points": [
[
20017,
"AC233F25A31B(Times Square)",
152,
2
],
[
8072,
"0117C5978008(KIA Bengaluru)",
231,
0
]
],
"columns": [
[
"product_id",
"product_name",
"notification_count",
"impression_count"
]
]
}
Get analytics overview for the product type over the time interval.
Product performance
curl "https://api.beaconstac.com/reporting/2.0/?organization={organization_id}&method=Products.getPerformance"
-H "Authorization: Token YOUR_TOKEN"
-d '{
"product_type": {type},
"product_id": {id},
"from": 1560796200000,
"to": 1561401000000,
"interval": "1d",
"timezone": "UTC"
}'
The above command returns JSON structured like this:
{
"points": [
8072,
"0117C5978008",
"0117C5978008",
231,
0,
0,
8361,
"KIA Bengaluru",
[
[
1560816000000,
73,
0,
0
],
[
1560902400000,
58,
0,
0
],
[
1560988800000,
35,
0,
0
],
[
1561075200000,
33,
0,
0
],
[
1561161600000,
0,
0,
0
],
[
1561248000000,
0,
0,
0
],
[
1561334400000,
32,
0,
0
]
]
],
"columns": [
"product_id",
"product_name",
"product_identifier",
"total_notification_count",
"total_impression_count",
"total_ctr",
"place_id",
"place_name",
[
[
"epoch_date",
"notification_count",
"impression_count",
"ctr"
]
]
]
}
Get analytics performace for the product.
Product impression detail
curl "https://api.beaconstac.com/reporting/2.0/?organization={organization_id}&method=Products.getImpressionDetail"
-H "Authorization: Token YOUR_TOKEN"
-d '{
"product_type": {type},
"place": {place_id},
"from": 1560796200000,
"to": 1561401000000
}'
The above command returns JSON structured like this:
{
"points": [
[
"15611148064w64ye",
2888,
"Times Square",
20017,
"AC233F25A31B",
"AC233F25A31B",
"2019-06-21T11:11:41.523Z",
"49.207.48.13",
"Mozilla/5.0 (iPhone; CPU iPhone OS 12_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.1 Mobile/15E148 Safari/604.1"
],
[
"15611148064w64ye",
2888,
"Times Square",
20017,
"AC233F25A31B",
"AC233F25A31B",
"2019-06-21T11:00:06.757Z",
"49.207.48.13",
"Mozilla/5.0 (iPhone; CPU iPhone OS 12_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.1 Mobile/15E148 Safari/604.1"
]
],
"columns": [
"cookie_id",
"place_id",
"place_name",
"product_id",
"product_name",
"product_identifier",
"iso_date",
"ip_address",
"user_agent"
]
}
Get impressions details generated by the product. If no place is provided data will be returned for all products of the product type specified in the organization.
Product impression distribution
curl "https://api.beaconstac.com/reporting/2.0/?organization={organization_id}&method=Products.getImpressionDistribution"
-H "Authorization: Token YOUR_TOKEN"
-d '{
"product_type": {type},
"place": {place_id},
"from": 1560796200000,
"to": 1561401000000
}'
The above command returns JSON structured like this:
{
"points": [
[
2888,
"Times Square",
[
20017,
"AC233F25A31B",
"AC233F25A31B",
2,
0,
2,
0
]
]
],
"columns": [
"place_id",
"place_name",
[
"product_id",
"product_name",
"product_identifier",
"impression_count",
"custom_impression",
"card_impression",
"form_impression"
]
]
}
Get impression distribution generated by the product. If no place is provided data will be returned for all products of the product type specified in the organization.
Generate product CSV data
curl "https://api.beaconstac.com/reporting/2.0/?organization={organization_id}&method=Csv.getProductData"
-H "Authorization: Token YOUR_TOKEN"
-d '{
"product_type": {type},
"organization_ids": [organization_id_1, organization_id_2],
"product_ids": [product_id_1, prodcut_id_2],
"from": 1559273172,
"to": 1559283172,
"timezone": "UTC"
}'
Generate a detailed CSV report for products in the specified organizations. The report will be emailed to the user email mentioned in the POST body. If not email is specified it would be emailed to the user making the request.
Errors
The Beaconstac API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The requested is hidden for administrators only. |
| 404 | Not Found -- The specified object could not be found. |
| 405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The requested has been removed from our servers. |
| 418 | I'm a teapot. |
| 429 | Too Many Requests -- You're requesting too many resources! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |