API Overview

This article will give you an overview on how the API & Webhook works for the Agency Features that we offer along with details on how to use it properly.

First of all make sure that your SEO Lead Gen.

API

The API will allow you to initiate tasks using simple requests.

Authentication

You will need your API token mentioned on the agency features page at the very bottom : https://dash.brandoverflow.com/agency

Endpoint : https://api3.brandoverflow.com/leads_api

Add Lead

This method will add a lead to the system that you can then view/process via the dashboard.

Endpoint https://api3.brandoverflow.com/leads_api
MethodPOST
Request Body

{
    "token" : "your_api_token",
    "url" : "https://your_url.com",
    "name" : "Full Name",
    "email" : "Email",
}

Add Lead + Process Audit Immediately.

This method will add a lead to the system and add it to the processing queue immediately.

Endpoint https://api3.brandoverflow.com/leads_api
MethodPOST
Request Body

{
    "token" : "your_api_token",
    "url" : "https://your_url.com",
    "name" : "Full Name",
    "email" : "Email",
    "process_immediately" : true,
    "max_pages": 10
}

Reference

KeyRequiredDescription
tokenYesYour api token as per your account settings
urlYesThe url of the website that is to be audited
nameYesName of the lead
emailYesEmail of the lead
process_immediatelyOptionalDefaults to false, if set to true, it will add the audit task to the processing queue immediately.
max_pagesOptionalNumber of pages to audit for this task.

Responses

If no error and everything went smoothly.

{
   "success" : true
}

If url is invalid or missing

{
   "success" : false,
   "message" : "URL is invalid"
}

If name is invalid or missing

{
   "success" : false,
   "message" : "Name is invalid"
}

If email is invalid or missing

{
   "success" : false,
   "message" : "Email is invalid"
}

If account doesnt have any limits left to process this request

{
   "success" : false,
   "message" : "Not enough Audit credits left."
}