Skip to main content
POST
/
api
/
workflow_manager
/
start
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "your token");

const raw = JSON.stringify({
  "workflow": "player_comparison",
  "websites": [
    "stripe.com",
    "paypal.com"
  ],
  "workbook_name": "Test report"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("{{path}}/api/workflow_manager/start/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

{
    "report_id": 1002345
}

​
Overview

Generates a comprehensive comparison of up to 5 companies. The report analyzes multiple dimensions including company fundamentals and firmographics, product offerings and business models, employee reviews and satisfaction, hiring trends and workforce data, and online presence and market visibility.

​
Endpoint Details

  • Method: POST
  • Endpoint: /api/workflow_manager/start

​
Authentication requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

​
Request

​
Request Parameters

​
Header Parameters

​
token
string
required
JWT token obtained from the Authentication request

​
Body Parameters

​
workflow
string
required
player_comparison
​
websites
An array of strings
required
Array of company websites to compare
​
workbook_name
(string)
Name with which the workbook will be saved
Sample payload 
{
    "workflow": "player_comparison",
    "websites": [
        "stripe.com",
        "paypal.com"
    ],
    "workbook_name": "Player Comparison Report"
}

​
Response

Successful response will include the report_id of the Peer Comparison report

​
Successful Response Fields

​
report_id
integer
Report id for the initiated Peer Comparison Report
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "your token");

const raw = JSON.stringify({
  "workflow": "player_comparison",
  "websites": [
    "stripe.com",
    "paypal.com"
  ],
  "workbook_name": "Test report"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("{{path}}/api/workflow_manager/start/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

{
    "report_id": 1002345
}