v4

latestOpenAPI 3.0.3raw.githubusercontent.com2023-03-26273865.4 KB
Experiences

Get In-Page Experiences

Gets a list of all experiences in the account

get/accounts/{{account_id}}/experiences

Query parameters

sortstring

Sort the result by the specified field. A - prefix can be added to reverse the sort order

qstring

Search string for searching In-Page Experience titles and descriptions

Response

SUCCESS

Example response

{
  "items": [
    {
      "id": "111111111111",
      "accountId": 1111111111111,
      "name": "Sample In-Page Experience",
      "description": "A sample In-Page Experience for demonstration purposes",
      "template": "ee-single-video",
      "templateVersion": "1.0.0",
      "styles": {
        "global": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "anchor": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "navigation": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "videoInfo": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "videoTitle": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "videoDescription": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "overlay": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "overlayTitle": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "overlayDescription": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "overlayBanner": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "nowPlaying": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "playButton": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "sharing": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "overlaySharing": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "eventCountdown": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        },
        "calendarReminder": {
          "color": "rgba(255, 0, 0, 1)",
          "backgroundColor": "blue",
          "fontSize": "14"
        }
      }
    }
  ]
}
All 27 operations