---
title: "Get In-Page Experience Interaction"
method: GET
path: "/accounts/{{account_id}}/interactions/{interaction_id}"
tags: ["Interactions"]
---

# Get In-Page Experience Interaction

`GET /accounts/{{account_id}}/interactions/{interaction_id}`

Gets a specific In-Page Experience interaction in the account

## Response `200`

SUCCESS

- Interaction — Object describing the interaction
  - `id` string — The id for the interaction
  - `accountId` string — The id of the account that the interaction interaction belongs to.
  - `start` object — Object describing the starting point where the interaction becomes active
    - `quantity` number — position of the start point, either in seconds or a percentage of the video duration
    - `from` 'start' | 'end' — where the `quantity` is measured from
    - `unit` 'percent' | 'seconds' — what usits are used for the `quantity`
  - `end` object — Object describing the end point where the interaction becomes inactive
    - `quantity` number — position of the end point, either in seconds or a percentage of the video duration
    - `from` 'start' | 'end' — where the `quantity` is measured from
    - `unit` 'percent' | 'seconds' — what usits are used for the `quantity`
  - `createdAt` string — A date-time string indicating when the interaction was created
  - `updatedAt` string — A date-time string indicating when the interaction was last modified
  - `type` 'Link' | 'Card' | 'External', required — The type of interaction - `Link` - A hyperlink - `Card` - A card that can contain text, a link, and/or an image - `External` - A custom type built with HTML, CSS, and JavaScript.
  - `durationType` 'point' | 'span' | 'end' | 'full' — Duration type of the interaction - `point` - it appears at some point in playback - `span` - it is available over some span of playback - `end` - it is available at the end of playback - `full` - it is always available There is no need to set `durationType` if you are setting `start` and `end`. It will simply reflect what you set there. For `durationType` set to `end` or `full` **only**, you can use this as a shortcut instead of setting `start` and `end`.
  - `experience` string — An experience id. If specified when you create an interaction, the interaction will belong to that experience. If you do not specify an experience, the interaction can be used by any experience.
  - `placement` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — Physical placement of a `Link` interaction. Used only for 'Link' tupes interactions
  - `text` string — Link text for a hyperlink. Used for `Link` and `Card` type interactions.
  - `href` string — The URL that a hyperlink points to. Used for `Link` and `Card` type interactions.
  - `title` string — The title for a card. Used for`Card` type interactions.
  - `description` string — The description for a card. Used for`Card` type interactions.
  - `img` string — A URL pointing to the image for a card. Used for`Card` type interactions.

## Other responses

- `401` — UNAUTHORIZED: Authentication failed - check to make sure your client credentials were correct for the access token
- `404` — NOT_FOUND: The specified In-Page Experience does not exist

---

[API](https://skmtc.net/brightcovelearning/apis/brightcove-in-page-experiences-api-reference.md) · [All operations](https://skmtc.net/brightcovelearning/apis/brightcove-in-page-experiences-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brightcovelearning/brightcove-in-page-experiences-api-reference/revisions/4ba1a5bb9017/schema)