API Recipe: Create LiveConnect Journeys

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Overview

To create a LiveConnect Journey with the ObservePoint API, make sure that you have the ObservePoint LiveConnect certificate downloaded and installed on your device. See LiveConnect: Certificate and Proxy Setup for setup and configuration. See also LiveConnect: Create a New Journey for a refresher on creating Journeys in LiveConnect.

This recipe outlines the API process as done in Postman or through the terminal using cURL.

Authentication

Follow the instructions in the Authentication section.

Get All Configured Devices

Make a GET call to https://api.observepoint.com/v2/manual-journeys to return a list of all the devices for your account, and more importantly to obtain the id of the device.

[
  {
    ...
    "id": 123,
    ...
  }
]

Start a New Session with Device

Now that we have the ID, make a POST call to https://api.observepoint.com/v2/manual-journeys/{manualJourneyId} and use the id returned from the above GET call and replace {manualJourneyId} with it.

curl -X POST "https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}" \
  -H "Authorization: api_key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

A response with the proxy IP address, proxy port, and run ID well be returned.

{
  "name": "MacBook Pro 1 January 2025 | 12:00AM",
  "certificate": null,
  "journeyId": 123456,
  "proxyInfo": {
    "interface": "123.456.789.123",
    "port": 54321,
    "authorization": null
  },
  "runId": 9876
}

Take the Proxy information and enter it into the device that you will run LiveConnect on.

Control the Session

Using the Run ID from the last call you made, make calls to POST https://api.observepoint.com/v2/manual-journeys/920/runs/{runId}/control to control your session.

To start begin to have the LiveConnect session start listening, send the following to the above endpoint:

{ "request": "start" }

You can control the LiveConnect session with the follwing request values:

Actions (optional)

If there is a desire to document the steps taken during the connected session so the data is easily parsed out (e.g. I want to easily see all data associated with clicking on a CTA on an application), you can document those actions while a LiveConnect session is listening by making calls to POST https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions with the following payload:

{
  "name": "Click on CTA",
  "actionType": 1,
  "sequence": 1, //updating the sequence as you add more actions. The creation of the session creates step 1 automatically.
  "note": "Clicks on the CTA of the homepage",
  "runId": {manualJourneyId}
}

You can view the data by going into the ObservePoint application.