Campaigns and trackable QR Codes
Notes
This method is only available to registered users.
Get a list of campaigns and QR codes
GET track/list
Parameters
auth
| string
| required
| API key for authentication. Get API key at your Profile page.
|
Response
Response returns a list of tracked records.
campaigns
| array
| Array of Campaign objects, see below.
|
qrcodes
| array
| Array of QR Code objects, see below.
|
Campaign entity:
id
| string
| Campaign identifier.
|
name
| string
| Campaign name.
|
description
| string
| Campaign description.
|
created
| timestamp
| Date and time when the campaign was created.
|
QR Code entity:
id
| string
| QR Code identifier.
|
campaignId
| string
| Campaign identifier to which QR Code belongs.
|
name
| string
| QR Code name.
|
content
| string
| Content encoded into QR Code.
|
shortUrl
| string
| Hyperlink for tracking.
|
scans
| int
| Number of scans.
|
isAvailable
| bool
| A value indicating whether QR Code data is available to user. May be restricted according to user's package plan.
|
created
| timestamp
| Date and time when the QR Code was created.
|
Example
Get records for user authenticated with API key
d3m04u7h. Note that response is re-formatted and simplified for human reading.
Request:
GET http://www.esponce.com/api/v3/track/list?auth=d3m04u7h
Response:
{
campaigns:
[
{
id: "ebf4e007447846f292234ea185a6b95d",
name: "API codes",
description: "Campaign contains QR Codes for testing web service.",
created: "2012-01-10T12:16:13Z"
},
{
id: "006025e19513445aa735befbc49b4f67",
name: "Experimental",
description: "Campaign used to test QR Code parameters. QR Codes from this campaign are not published and can be deleted.",
created: "2012-01-10T12:17:20Z"
}
],
qrcodes:
[
{
id: "5e5c8e388830410eb197c65343b4c2dd",
campaignId: "ebf4e007447846f292234ea185a6b95d",
name: "Web site: esponce.com",
shortUrl: "http://goo.by/w9KP4B",
content: "http://www.esponce.com",
scans: 0,
created: "2012-01-10T12:19:11Z"
},
{
id: "c880bbc9bb4c43b5872fa17f144f38f4",
campaignId: "ebf4e007447846f292234ea185a6b95d",
name: "Twitter: follow @esponcetag",
shortUrl: "http://goo.by/wFjKeZ/follow-esponcetag",
content: "http://twitter.com/esponcetag",
scans: 1,
created: "2012-01-10T12:21:40Z"
},
{
id: "b8881b8fbd6840b0a8a2ed304bcb37b0",
name: "Contact card",
shortUrl: "http://goo.by/wxfpmb/card",
content: "MECARD:N:Bar,Foo;TEL:123456789;ADR:,,;,;,;,;,;;EMAIL:demo@esponce.com;URL:http://www.esponce.com;;",
scans: 0,
created: "2012-01-10T12:26:44Z"
}
]
}