Info: To enable any of the Monitoring API, please contact your LivePerson account team.

Introduction

Welcome to the API documentation for Synthetic Monitoring for brands, a powerful tool that allows access to end-to-end testing data. With this API, brands can easily analyze and optimize their testing processes, enabling them to identify and address any issues before they impact their customers. This document provides detailed instructions and examples for developers looking to integrate with the API. We'll cover everything from authentication to error handling, and provide guidance on best practices for using the API.

To get started, you'll need to have a basic understanding of RESTful APIs and experience with JSON. You'll also need credentials to authenticate requests.

If you're ready to get started, let's dive in and explore the features of E2E for brands. If you have any questions or need assistance, please don't hesitate to contact our support team.

Getting started

Before you can use the E2E Synthetic for Brands API, you'll need to complete a few steps to set up your account and get started. Follow the steps below to get started.

1.Contact Support To use the Synthetic monitoring for Brands API, you'll need to contact your Liveperson representative

2.Secure Your Credentials Once you receive your credentials from our support team, it's important to keep them secure. You should not share your credentials with anyone else, and you should take steps to protect them from unauthorized access.

3.Read the Documentation Before you begin using the Synthetic monitoring for Brands API, it's important to read the documentation carefully. The documentation provides detailed information about how to use the API, including authentication, endpoints, and response formats.

4.Add the Synthetic monitoring for Brands Product to Your Application Once you have read the documentation and secured your credentials, you can begin integrating the Synthetic monitoring for Brands product into your application. You'll need to use your credentials to authenticate your API requests, and you can use the endpoints described in the documentation to retrieve test data and results for your brand.

If you encounter any issues while setting up your account or using the API, please don't hesitate to contact a Liveperson representative for assistance. We're here to help you get started and make the most of the E2E for Brands product.

Authentication:

E2E for brands uses JSON Web Tokens (JWTs) to authenticate and authorize requests. To obtain a JWT, you must send a POST request to the [/authenticate/v1/jwt] endpoint with your credentials in the request body.

Request:

POST /authenticate/v1/jwt HTTP/1.1
Host: 
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password"
}

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "token": "your_access_token"
}

Once you have obtained a JWT, you must include it in the Authorization header of all subsequent requests. The header should be formatted as follows:

Authorization: Bearer your_access_token

If you receive a 401 Unauthorized response, it means that your JWT is either invalid or has expired. In this case, you should obtain a new JWT by sending another request to the [/authenticate/v1/jwt] endpoint.

Note: Your JWT is valid for a limited time, after which you will need to obtain a new token. The expiration time of the token will be included in the exp claim of the JWT payload.

Methods

/api/v1/brands/results

Description

This endpoint returns the latest testing results and its data for a given brand in the system.

Request

GET /api/v1/brands/results HTTP/1.1
Host: 
Authorization: Bearer your_access_token

Request Headers

Request Body

Response

Response Codes

Response example

 HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "testName": "test name",
        "testTimestamp": "2022-12-30T16:42:43.000+00:00",
        "status": "Passed"
    },
    {
        "testName": "test name 2",
        "testTimestamp": "2022-12-30T16:42:43.000+00:00",
        "status": "Failed"
    },
    {
        "testName": "test name 3",
        "testTimestamp": "2022-12-30T16:42:43.000+00:00",
        "status": "Passed"
    },
    ...
]