Pushing data to Runway – Runway Help Center

Data model

Runway currently accepts driver-like data through our API. If you’re interested in uploading database-like data through our API, please contact success@runway.com.

📣

Note: we use strings instead of numbers in JSON to avoid precision issues with numbers in Javascript.

Drivers pushed to Runway’s API have the following fields:

Name	Type	Description
`id`	string	string identifier for the driver, use something stable on your end
`path`	array	array of strings identifying the driver for display
`timeSeries`	array	array of time series points
↳ `time`	string	UNIX timestamp value for time series point
↳ `value`	string	numeric value

Endpoints

All endpoints accept JSON as input data.

POST https://api.runway.com/api/extDrivers/update

Request fields:

Name	Type	Description	Required?
`shouldDeleteMissing`	boolean	Default is `false`When set to `true`, any time series points or drivers missing are deleted from Runway. Set this when you want to push a complete snapshot on every update.	no
`extDrivers`	array	array of objects	yes
↳ `id`	string	Set to a stable ID on your end	yes
↳ `path`	array	Array of strings. The display name of the driver. Allows for hierarchical organization of drivers. example: path = [ “Users”, “Retention” ] and path = [”Users”, “Sign Ups”]. Allows “Sign Ups” and “Retention” to be nested under “Users”.	yes
↳ `timeSeries`	array	array of objects	yes
↳ `time`	string	UNIX timestamp for this time series point. Currently Runway only allows 1 time series point per month and will use the most recent update for any given month.	yes
↳ `value`	string	A string representing the numeric value of this time series point (e.g. “1234”). no symbols allowed.	yes

Example request

{
    "shouldDeleteMissing": true,
    "extDrivers": [
        {
            "id": "1",
            "path": [
                "Users"
            ],
            "timeSeries": [
                {
                    "time": "1675738308",
                    "value": "124128512"
                }
            ]
        },
        {
            "id": "2",
            "path": [
                "Users",
                "Retention"
            ],
            "timeSeries": [
                {
                    "time": "1675738308",
                    "value": "0.85"
                }
            ]
        }
    ]
}

Response

On success, the API returns an empty response with status code 200.