• Create an account Sign in

Data exporting API

Data exporting

The data exporting API allows you to extend what we're doing and build your own tools such as the Heatmap Emitter for Unity3d by Chris Ellis, or export your data to your own systems for integration with your internal tools and dashboards. If you make a cool tool let us know so we can tell our users about it!

Requirements

• Each game must have an API key. If your game predates API keys you can assign one in the "edit game details" page.
• Your account must have a secret token that you enter on your account page.

If you're updating that information now it might take a minute or two for the API servers to recognize your changes.

Accessing your data

The data resides on the url:

https://data.playtomic.com/v1/authstring/

This domain is equipped with an allow-all crossdomain.xml for access via Flash and Unity3d, and Access-Control-* headers to allow JavaScript cross-origin requests.

Your authstring

Your auth code varies for each game. You can access it via the dashboard in your account settings or create it yourself using:

Md5(userid + "/" + secret token + "/" + gameid + "/" + gameapikey)

Accessing the data

General data

https://data.playtomic.com/v1/authstring/general

Optionally include these parameters in the url (/general?aaaa=bbbbbb&ccccc=ddddddd)

Parameter	Values
mode	total (default), today, yesterday, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
output	xml (default), json

Check these URLs to see the returned data formats:

• No parameters (xml) general
• Today (xml) general?mode=today
• December 2011 (xml) general?mode=12/1/2011-12/30/2011
• No parameters (json) general?output=json
• Today (json) general?mode=today&output=json
• December 2011 (json) general?mode=12/1/2011-12/30/2011&output=json

Custom Metrics

https://data.playtomic.com/v1/authstring/custommetrics

If you include no mode parameter it will return a list of your metrics, or include these parameters in the url (/general?aaaa=bbbbbb&ccccc=ddddddd)

Parameter	Values
mode	total (default), today, yesterday, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
metric	the name of one of your metrics, url encoded
group	the name of one of your groups, url encoded, to return all metrics in the group
output	xml (default), json

Check these URLs to see the returned data formats:

• Metric list (xml) custommetrics
• Today's totals (xml) custommetrics?mode=today
• December 2011 (xml) custommetrics?mode=12/1/2011-12/30/2011
• Walkthrough metric for December 2011 (xml) custommetrics?mode=12/1/2011-12/30/2011&metric=walkthrough
• All 'ungrouped' metrics totals (xml) custommetrics?mode=total&group=ungrouped
• Metric list (json) custommetrics?output=json
• Today (json) cusotmmetrics?mode=today&output=json
• December 2011 (json) custommetrics?mode=12/1/2011-12/30/2011&output=json
• Walkthrough metric for December 2011 (json) custommetrics?mode=12/1/2011-12/30/2011&metric=walkthrough&output=json
• All 'ungrouped' metrics totals (json) custommetrics?group=ungrouped&output=json

Heatmaps

https://data.playtomic.com/v1/authstring/heatmap

If you include no mode parameter it will return a list of your metrics, or include these parameters in the url (/general?aaaa=bbbbbb&ccccc=ddddddd)

Parameter	Values
mode	total (default), today, yesterday, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
metric	the name of one of your metrics, url encoded
output	png (default), xml, json, csv (used for heatmap emitter)

Check these URLs to see the returned data formats:

• Heatmap list (xml) heatmap
• Total "mousemove" (xml) heatmap?metric=mousemove&output=xml
• Today's "mousemove" (xml) heatmap?mode=today&metric=mousemove&output=xml
• December 2011's "mousemove" (xml) heatmap?mode=12/1/2011-12/30/2011&metric=mousemove&output=xml
• Heatmap list (json) heatmap?output=json
• Total "mousemove" (json) heatmap?metric=mousemove&output=json
• Today's "mousemove" (json) heatmap?mode=today&metric=mousemove&output=json
• December 2011's "mousemove" (json) heatmap?mode=12/1/2011-12/30/2011&metric=mousemove&output=json
• Total "mousemove" (png) heatmap?metric=mousemove
• Today's "mousemove" (png) heatmap?mode=today&metric=mouesmove
• December 2011's "mousemove" (png) heatmap?mode=12/1/2011-12/30/2011&metric=mouesmove

Level metrics

https://data.playtomic.com/v1/authstring/levelmetrics
https://data.playtomic.com/v1/authstring/levelrangedmetrics
https://data.playtomic.com/v1/authstring/levelaveragemetrics
https://data.playtomic.com/v1/authstring/levelcountermetrics

You can access a list of your metrics by going to the levelmetrics page. For data use each type's page and the following parameters.

Parameter	Values
mode	total (default), today, yesterday, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
metric	the name of one of your metrics, url encoded
level	the name or number of one of your levels, url encoded
output	xml (default), json

Check these URLs to see the returned data formats:

• Level metric list (xml) levelmetrics
• Level metric list (json) levelmetrics?output=json

• Today's totals (xml) levelrangedmetrics?mode=today
• December 2011 (xml) levelrangedmetrics?mode=12/1/2011-12/30/2011
• Walkthrough metric for December 2011 (xml) levelrangedmetrics?mode=12/1/2011-12/30/2011&metric=walkthrough
• All 'ungrouped' metrics totals (xml) levelrangedmetrics?mode=total&group=ungrouped
• Metric list (json) levelrangedmetrics?output=json
• Today (json) cusotmmetrics?mode=today&output=json
• December 2011 (json) custommetrics?mode=12/1/2011-12/30/2011&output=json
• Walkthrough metric for December 2011 (json) custommetrics?mode=12/1/2011-12/30/2011&metric=walkthrough&output=json
• All 'ungrouped' metrics totals (json) custommetrics?group=ungrouped&output=json

Countries and Sources

https://data.playtomic.com/v1/authstring/countries
https://data.playtomic.com/v1/authstring.sources

If you include no mode parameter it will return a list of your countries or source, or include these parameters in the url (/general?aaaa=bbbbbb&ccccc=ddddddd)

Parameter	Values
mode	total (default), today, yesterday, mm/dd/yyyy, mm/dd/yyyy-mm/dd/yyyy
country	the 2 digit country code of a country (eg AU for Australia)
source	The domain part of a url, eg armorgames.com (not http://www.armorgames.com/).
output	xml (default), json