v4

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

Get In-Page Experience Interactions

Retrieves a list of interactions related to the given accountId.

get/accounts/{{account_id}}/interactions

Response

SUCCESS

Example response

{
  "items": [
    {
      "start": {
        "quantity": 5,
        "from": "start",
        "unit": "seconds"
      },
      "end": {
        "quantity": 10,
        "from": "start",
        "unit": "seconds"
      },
      "durationType": "span",
      "type": "External",
      "content": [
        {
          "name": "Oregon Coast",
          "type": "text",
          "value": "<p>A peaceful morning on the coast of Oregon</p>"
        }
      ],
      "createdAt": "2018-09-30T19:00:12.114Z",
      "updatedAt": "2018-09-30T19:00:12.115Z",
      "experience": "5bb11c8880b4990011750ed1",
      "videoId": "5842159189001",
      "lookup": "right",
      "accountId": 57838016001,
      "id": "5bb11d3c5cdcdc001222ce1d"
    },
    {
      "start": {
        "quantity": 5,
        "from": "start",
        "unit": "seconds"
      },
      "end": {
        "quantity": 20.257,
        "from": "start",
        "unit": "seconds"
      },
      "durationType": "span",
      "playbackBehavior": "none",
      "type": "Card",
      "createdAt": "2018-11-07T15:25:27.666Z",
      "updatedAt": "2018-11-07T15:25:27.667Z",
      "experience": "5bc4991f0f6f340011b3e968",
      "videoId": "5857167159001",
      "title": "test",
      "img": null,
      "description": "",
      "href": "",
      "linkText": "",
      "openOnStart": false,
      "accountId": 57838016001,
      "id": "5be303e7b5cd1c00106dc287"
    },
    {
      "start": {
        "quantity": 50,
        "from": "start",
        "unit": "percent"
      },
      "end": {
        "quantity": 70,
        "from": "start",
        "unit": "percent"
      },
      "durationType": "point",
      "playbackBehavior": "none",
      "type": "Card",
      "createdAt": "2019-03-13T17:47:37.077Z",
      "updatedAt": "2019-03-13T17:47:37.078Z",
      "title": "Brightcove Support",
      "description": "Get help using Brightcove products",
      "linkText": "Brightcove Documentation",
      "href": "https://support.brightcove.com",
      "accountId": 57838016001,
      "id": "5c89423903b4450016165450"
    },
    {
      "start": {
        "quantity": 50,
        "from": "start",
        "unit": "percent"
      },
      "end": {
        "quantity": 70,
        "from": "start",
        "unit": "percent"
      },
      "durationType": "point",
      "placement": "top-right",
      "playbackBehavior": "none",
      "type": "Link",
      "createdAt": "2019-03-13T19:38:06.974Z",
      "updatedAt": "2019-03-13T19:38:06.975Z",
      "text": "Brightcove Documentation",
      "href": "https://support.brightcove.com",
      "accountId": 57838016001,
      "id": "5c895c1e009c2a0015c104af"
    }
  ]
}