Documentation Powered by ReDoc

Tiled API (0.9.8)

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.

Authentication

ApiKey

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

analytics

List all sessions

Returns a list of sessions for microapps in your account.

Authorizations:
ApiKey
query Parameters
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.

timezone
string
Example: timezone=PST

(Defaults to UTC) A specific timezone name to retrieve analytics session data. Please see the list of supported timezones at "TZ database name"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export all sessions

Returns a CSV export of sessions for microapps in your account.

Authorizations:
ApiKey
query Parameters
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.

timezone
string
Example: timezone=PST

(Defaults to UTC) A specific timezone name to retrieve analytics session data. Please see the list of supported timezones at "TZ database name"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

microapps

List all microapps

Returns a list of microapps in your account along with a few relevant properties.

Authorizations:
ApiKey
query Parameters
archived
boolean

Passing true will return microapps that have been archived in addition to non-archived microapps. The default is false.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Share microapp by id

Fires off an email to the recipientEmail using an email template. The email will contain a trackable link to the microapp you are sharing with the recipient along with the message set in your Tiled Account settings.

Authorizations:
ApiKey
path Parameters
microappId
required
string

The id of the microapp to share

query Parameters
userEmail
required
string

The email of the Tiled user sharing the microapp

recipientName
required
string

The name of the person receiving the microapp

recipientEmail
required
string

The email of the person receiving the microapp

sendEmail
boolean

If you want to send an email, set this to true. Otherwise, you can just use the link that comes back from this endpoint.

instanceId
object

The id of the instance object that should be inserted when sharing this microapp

expireAt
string <date-time>

The date on which the microapp should expire

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an instance of a microapp

Creates an instance of a microapp that can be shared using the microapp /share endpoint.

Authorizations:
ApiKey
path Parameters
microappId
required
string

The id of the microapp to which you want to associate a new instance

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "5be33ed244a5f409f38cad2a",
  • "title": "My Instance",
  • "data": {
    }
}

Update an instance of a microapp

Adds or removes keys from the data of an instance. The caller can also change the owner.

Authorizations:
ApiKey
path Parameters
instanceId
required
string

The id of the instance to update

query Parameters
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. ""), we'll remove the current owner.

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.

Responses

Response samples

Content type
application/json
{
  • "id": "5be33ed244a5f409f38cad2a",
  • "title": "My Instance",
  • "data": {
    }
}

sharedmicroapps

List all shared microapps

Returns a list of shared microapps in your account along with a few relevant properties.

Authorizations:
ApiKey
query Parameters
recipientId
required
string

The id of the recipient (e.g. email or unique identifier) whose shared microapp record you want to retrieve.

userEmail
string

Passing in an email here restricts the returned records to those sent by the Tiled user that has this email address.

extended
boolean

Passing in true will return extended information like the engagement score.

Responses

Response samples

Content type
application/json
[
  • {
    }
]