API docs by Redocly

STQRY Public API (1.0.0)

Download OpenAPI specification:

API Support: support@stqry.com URL: https://support.stqry.com License: Copyright OnCell Systems, Inc.

API documentation for STQRY's public API

Codes

Returns a list of codes for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "coupon_code" "valid_from" "valid_to" "redemptions" "id"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

include_archived
boolean

Include archived codes

tags
string

Comma separated list of tags. Tags are ANDed

valid_now
boolean

Currently valid codes

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "codes": [
    ]
}

Creates a new code

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Returns a single code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": {
    }
}

Updates an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Updates an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Deletes an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

CollectionItems

Returns a list of collection items for a collection

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "collection_items": [
    ]
}

Creates a new collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem" "CrossRegionLink"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates the positions of collection items within a collection

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of collection item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to update

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem" "CrossRegionLink"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to update

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem" "CrossRegionLink"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Deletes an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Collections

Returns a list of collections for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

tags
string

Comma separated list of tags. Tags are ANDed

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "collections": [
    ]
}

Creates a new collection

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

file_size
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_about
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_tips
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
required
boolean
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "description": { },
  • "code_title": { },
  • "code_text": { },
  • "file_size": { },
  • "stqry_directory_description": { },
  • "stqry_directory_about": { },
  • "stqry_directory_tips": { },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Returns a single collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to retrieve

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Updates an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to update

Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

file_size
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_about
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_tips
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
required
boolean
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "description": { },
  • "code_title": { },
  • "code_text": { },
  • "file_size": { },
  • "stqry_directory_description": { },
  • "stqry_directory_about": { },
  • "stqry_directory_tips": { },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Updates an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to update

Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

code_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

file_size
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_about
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_tips
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
required
boolean
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "description": { },
  • "code_title": { },
  • "code_text": { },
  • "file_size": { },
  • "stqry_directory_description": { },
  • "stqry_directory_about": { },
  • "stqry_directory_tips": { },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Deletes an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole collection)

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

MediaItems

Returns a list of media_items for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "media_items": [
    ]
}

Creates a new media item

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
caption
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

attribution
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Returns a single media_item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Updates an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to update

Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
caption
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

attribution
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Updates an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to update

Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
caption
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

attribution
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Deletes an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole media item)

Responses

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Projects

Returns a list of projects for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

tags
string

Comma separated list of tags. Tags are ANDed

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "projects": [
    ]
}

Returns a single project

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project to retrieve

Responses

Response samples

Content type
application/json
{
  • "project": {
    }
}

Screens

Returns a list of screens for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "screens": [
    ]
}

Creates a new screen

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_short_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_full_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "stqry_directory_short_description": { },
  • "stqry_directory_full_description": { },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": { },
  • "html": { },
  • "css": { }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Returns a single screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to retrieve

Responses

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Updates an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to update

Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_short_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_full_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "stqry_directory_short_description": { },
  • "stqry_directory_full_description": { },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": { },
  • "html": { },
  • "css": { }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Updates an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to update

Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "ko" "lkt" "lld" "lo" "lt" "lv" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

short_title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_short_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

stqry_directory_full_description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": { },
  • "short_title": { },
  • "stqry_directory_short_description": { },
  • "stqry_directory_full_description": { },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": { },
  • "html": { },
  • "css": { }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Deletes an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole screen)

Responses

Response samples

Content type
application/json
{
  • "screen": {
    }
}

StorySectionBadgeItems

Returns a list of badge items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to update

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to update

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing badge item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySectionLinkItems

Returns a list of link items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
item_type
string
Enum: "Bundle" "Collection" "CollectionItem" "Screen" "MediaItem" "CrossRegionLink"
integer or null
position
integer
link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

url
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": { },
  • "url": { },
  • "username": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to update

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
item_type
string
Enum: "Bundle" "Collection" "CollectionItem" "Screen" "MediaItem" "CrossRegionLink"
integer or null
position
integer
link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

url
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": { },
  • "url": { },
  • "username": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to update

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
item_type
string
Enum: "Bundle" "Collection" "CollectionItem" "Screen" "MediaItem" "CrossRegionLink"
integer or null
position
integer
link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

url
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": { },
  • "url": { },
  • "username": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing link item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySectionMediaItems

Returns a list of media items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to update

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to update

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing media item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySectionOpeningTimeItems

Returns a list of opening time items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

time
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": { },
  • "time": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to update

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

time
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": { },
  • "time": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to update

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

time
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": { },
  • "time": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing opening time item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySectionPriceItems

Returns a list of price items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to update

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to update

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
description
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing price item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySectionSocialItems

Returns a list of social items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": { },
  • "link_text": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to update

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": { },
  • "link_text": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to update

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
username
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

link_text
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": { },
  • "link_text": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing social item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

StorySections

Returns a list of story sections for a screen

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "story_sections": [
    ]
}

Creates a new story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

hide
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
subtitle
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

body
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": { },
  • "hide": { },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates the positions of story sections within a screen

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of story section position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to retrieve

Responses

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to update

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

hide
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
subtitle
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

body
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": { },
  • "hide": { },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to update

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
title
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

hide
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
subtitle
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

body
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": { },
  • "hide": { },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Deletes an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole story section)

Responses

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

UploadedFiles

Returns a list of uploaded files for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "upload_file_name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "uploaded_files": [
    ]
}

Creates a new uploaded file record

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Returns a presigned URL for uploading a file to S3

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Presigned URL request

filename
required
string

The filename to upload

Responses

Request samples

Content type
application/json
{
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "fields": { }
}

Enqueues a file from S3 for processing

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Process enqueue request

s3_url
required
string

The S3 URL of the file to process

subtype
string

File subtype (e.g. map, geo_map)

focal_point
string

Focal point coordinates (e.g. 0.5,0.5)

Responses

Request samples

Content type
application/json
{
  • "s3_url": "string",
  • "subtype": "string",
  • "focal_point": "string"
}

Response samples

Content type
application/json
{
  • "job_id": "string"
}

Returns the status of a file processing job

Authorizations:
ApiKeyAuth
path Parameters
job_id
required
string

The Sidekiq job ID returned from process_enqueue

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "at": 0,
  • "pct_complete": 0,
  • "message": "string",
  • "uploaded_file": {
    }
}

Returns a single uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to retrieve

Responses

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Updates an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to update

Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Updates an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to update

Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Deletes an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

stqry