Download OpenAPI specification:Download
This API exposes the power of Tiled through programmatic access. You can automate workflows, integrate with your CRM or embed Tiled in your CMS. All you need to do is generate an API key from your Tiled account and you're ready to go!
If you need help working with the API, we recommend downloading our Postman collection which can be imported from https://www.getpostman.com/collections/48dab7ebed0ca84b000a. To get the collection working, you'll need to setup an environment and replace environment
with v1
and apiKey
with the API key you copied from the Tiled website.
All endpoints must be accompanied with an apiKey
as a url param. If the request is a POST
or PUT
, apiKey
can instead be passed in the JSON body. For instance, to get a list of microapps, you would call https://v1.tiled.co/microapps?apiKey=myKey
. You can generate API keys (or tokens) by going to https://app.tiled.co, clicking on your avatar in the upper right, selecting "Account Settings" and scrolling down to the section named "API Tokens". You can generate a key here as well as name it. Caution, the key/token will only be displayed once so copy it and keep it in a safe place. Keys can be generated and deleted anytime from this interface.
Security Scheme Type | API Key |
---|---|
Query parameter name: | apiKey |
Returns a list of sessions for microapps in your account.
date required | string <date-time> The date for which you want to retrieve analytics session data |
microappId | string Example: microappId=95953ed244a5f409f38cad2a A specific microapp Id that you want sessions and completion events for. |
An array of microapp sessions for the account
Unauthorized Error
[- {
- "id": "5be33ed244a5f409f38cad2c",
- "userId": "user@tiled.co",
- "microappId": "5be33ed244a5f409f38cad2b",
- "microappName": "Test microapp",
- "startTime": "2018-11-11 19:36:50.095Z",
- "endTime": "2018-11-12 19:36:50.095Z",
- "activeDuration": 44.5,
- "completionEvents": [
- {
- "payload": {
- "userId": "testing@tiled.co",
- "microappId": "5be33ed244a5f409f38cad2b",
- "microappName": "Test microapp",
- "completionName": "cmpt__5be33ed244a5f409f38cad2b__v__4ac33ed122a5f245f38ca2222"
}, - "completedAt": "2018-12-10T21:12:09.497z"
}, - {
- "payload": {
- "userId": "testing@tiled.co",
- "microappId": "5be33ed244a5f409f38cad2b",
- "microappName": "Test microapp",
- "completionName": "cmpt__5be33ed244a5f409f38cad2b__v__8ac33ed008b5f325f14ca4444"
}, - "completedAt": "2018-12-10T21:15:10.422z"
}
]
}
]
Returns a CSV export of sessions for microapps in your account.
date required | string <date-time> The date for which you want to retrieve analytics session data. |
microappId | string Example: microappId=95953ed244a5f409f38cad2a A specific microapp Id that you want sessions and completion events for. |
A CSV export of microapp sessions for the account
Unauthorized Error
[- {
- "id": "9b4b7347-6fb2-4a14-a3a5-f7a60be7f9fb",
- "microappId": "5be33ed244a5f409f38cad2b",
- "microappName": "My microapp",
- "userId": "user@tiled.co",
- "startTime": "2018-11-11 19:36:50.095Z",
- "endTime": "2018-11-12 19:36:50.095Z",
- "activeDuration": 44.5,
- "completionEvents": 3,
- "completionNames": [
- "cmpt__5c01d29917969b6976caa554",
- "cmpt__8a81d29917969b6976caa995"
]
}
]
Returns a list of microapps in your account along with a few relevant properties.
archived | boolean Passing true will return microapps that have been archived in addition to non-archived microapps. The default is false. |
An array of microapps in the account
Unauthorized Error
[- {
- "id": "5be33ed244a5f409f38cad2b",
- "title": "My Microapp",
- "updatedAt": "2018-11-07 19:36:50.095Z",
- "createdAt": "2018-11-08 19:36:50.095Z",
- "publishedAt": "2018-11-09 19:36:50.095Z",
- "categoryNames": [
- "Category1",
- "Category2"
], - "archived": true
}
]
Creates an instance of a microapp that can be shared using the microapp /share
endpoint.
microappId required | string The id of the microapp to which you want to associate a new instance |
userEmail | string The email of the Tiled user that will own this instance. If you omit this, everyone in your organization will have access to this instance. |
title required | string The name to give this instance |
data required | object A key/value dictionary to associate with this instance. You can find the API names for instance data mapping from the Settings dialog of a microapp in the Hub. |
Expected response to a valid request
Bad Request Error
Unauthorized Error
{- "id": "5be33ed244a5f409f38cad2a",
- "title": "My Instance",
- "data": {
- "dataMappingName1": "value1",
- "dataMappingName2": "value2"
}
}
Adds or removes keys from the data of an instance. The caller can also change the owner.
instanceId required | string The id of the instance to update |
userEmail | string The email of the Tiled user that owns this instance. If you omit this, the owner will not change. If you set this to empty string (i.e. |
title | string The name to update this instance with |
data | object A key/value dictionary to update this instance with. If this is omitted, the value won't change. You can find the API names for instance data mappings from the Settings dialog of a microapp in the Hub. |
Expected response to a valid request
Bad Request Error
Unauthorized Error
{- "id": "5be33ed244a5f409f38cad2a",
- "title": "My Instance",
- "data": {
- "dataMappingName1": "value1",
- "dataMappingName2": "value2"
}
}
The link structure to embed a Tiled microapp in an iframe. The embed can be copied from the settings pane of a microapp and the iframe code will look something like
<iframe src="https://s.tiled.co/abcdef7?dynamic=true&recipientId=7bdc2f3fb094448392619a5465402128&recipientName=Bob%20Beetlejuice&data=%7B"test"%3A"val1"%2C"test-2"%3A"val2"%7D" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen width="800" height="450"></iframe>
shortUrlKey required | string The shortened url for key for the embedded microapp |
dynamic | boolean This must be set to "true" if you want to track the viewer as a unique user |
recipientId | string A unique identifier (e.g. email, GUID. Must be unique) of the person receiving the microapp. Required if dynamic=true |
recipientName | string The full name of the person receiving the microapp |
userEmail | string The email of the Tiled user you would like to associate with this session. By setting this, you can find all the analytics for a session by drilling into this Tiled user on Tiled's website. |
data | string The JSON instance data to insert into this microapp. Note that this parameter will need to be URI encoded just like any other URL param. You can find the API names for instance data mappings from the Settings dialog of a microapp in the Hub. |
HTML for microapp embed
By using a URL like https://app.tiled.co/microapp/abc1234
, you are able to link directly to a microapp. This only applies to users who have an account in Tiled. When going to this URL, you will either go to the microapp in your browser or you will deep link into the iOS or Android app if you open it on a mobile device with the Tiled app installed. You can construct this link programatically by taking the microappId from the /microapps
endpoint and appending it to https://app.tiled.co/microapp/
microappId required | string The id for the microapp you want to link to |
Deep link to microapp