API Reference

Welcome to SMBStreams API! You can use this API to access all our API endpoints and dive into '000s of signals to enrich your database.

The API is organized around REST. All requests should be made over SSL. All request and response bodies are encoded in JSON.

PROPERTIES

The (meta) object is used across all APIs.

Field Type Description
count

Number

The number of items returned in this object.

record_id

String

The unique identifier of the record.

status

Number

The HTTP status code of the operation.

message

String

A message applying to the last operation.

Enrich Records

Enrich Records - Individual

Get signals for an individual business entity.

https://apis.buzzboard.com/v4.0/records/enrich

Parameters

Field Type Description
business_name Required

String

Name of the record.

website Required

String

Record website. Required unless city and state fields are provided.

phone

String

Record phone number.

contact_info

Object

Record contact information. For more information about the contact_info object see Contact Info.

address Required

Object

Record address information. For more information about the address object see Address.

primary_category_id

Number

Primary category Id of the record. See Category List.

secondary_category_id

Number

Secondary category Id of the record. See Category List.

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

Creates a new record 'Design Services Company' with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/records/enrich"
-H "authorization: Bearer ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{ "data": { "business_name": "Design Services Company", "website": "http://www.designservice.com", "phone": "(541) 754-3010", "contact_info": { "first_name": "Mathew", "last_name": "Cooper", "email": "mathew@designservice.com", "mobile": "5417543011", "title": "Mr", "phone": "(541) 754-3010" }, "address": { "line1": "151th Street", "city": "Miami", "zip": "12011", "state": "FL", "country": "United States" }, "primary_category_id": 57, "secondary_category_id": 45, "keywords": [ "My Business for Everything", "By Business", "Only Business" ], "external_id": "1237" } }'
var request = require('request');

var options = { method: 'POST',
  url: 'https://apis.buzzboard.com/v4.0/records/enrich',headers: 
   { 'cache-control': 'no-cache',
     authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' },
  body: 
   { data: 
      { business_name: 'Design Services Company',
        website: 'http://www.designservice.com',
        phone: '(541) 754-3010',
        contact_info: 
         { first_name: 'Mathew',
           last_name: 'Cooper',
           email: 'mathew@designservice.com',
           mobile: '5417543011',
           title: 'Mr',
           phone: '(541) 754-3010' },
        address: 
         { line1: '151th Street',
           city: 'Miami',
           zip: '12011',
           state: 'FL',
           country: 'United States' },
        primary_category_id: 57,
        secondary_category_id: 45,
        keywords: [ 'My Business for Everything', 'By Business', 'Only Business' ],
        external_id: '1237' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  
});
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/records/enrich");
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array("cache-control" => "no-cache",
  "authorization" => "Bearer ACCESS_TOKEN",
  "content-type" => "application/json"
));

$request->setBody("{
  "data": {
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "keywords": [
      "My Business for Everything",
      "By Business",
      "Only Business"
    ],
    "external_id": "1237"
  }
}");

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/records/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"
request.body = "{\r\n  \"data\": {\r\n    \"business_name\": \"Design Services Company\",\r\n    \"website\": \"http://www.designservice.com\",\r\n    \"phone\": \"(541) 754-3010\",\r\n    \"contact_info\": {\r\n      \"first_name\": \"Mathew\",\r\n      \"last_name\": \"Cooper\",\r\n      \"email\": \"mathew@designservice.com\",\r\n      \"mobile\": \"5417543011\",\r\n      \"title\": \"Mr\",\r\n      \"phone\": \"(541) 754-3010\"\r\n    },\r\n    \"address\": {\r\n      \"line1\": \"151th Street\",\r\n      \"city\": \"Miami\",\r\n      \"zip\": \"12011\",\r\n      \"state\": \"FL\",\r\n      \"country\": \"United States\"\r\n    },\r\n    \"primary_category_id\": 57,\r\n    \"secondary_category_id\": 45,\r\n    \"keywords\": [\r\n      \"My Business for Everything\",\r\n      \"By Business\",\r\n      \"Only Business\"\r\n    ],\r\n    \"external_id\": \"1237\"\r\n  }\r\n}"

response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/records/enrich"

payload = "{\r\n  \"data\": {\r\n    \"business_name\": \"Design Services Company\",\r\n    \"website\": \"http://www.designservice.com\",\r\n    \"phone\": \"(541) 754-3010\",\r\n    \"contact_info\": {\r\n      \"first_name\": \"Mathew\",\r\n      \"last_name\": \"Cooper\",\r\n      \"email\": \"mathew@designservice.com\",\r\n      \"mobile\": \"5417543011\",\r\n      \"title\": \"Mr\",\r\n      \"phone\": \"(541) 754-3010\"\r\n    },\r\n    \"address\": {\r\n      \"line1\": \"151th Street\",\r\n      \"city\": \"Miami\",\r\n      \"zip\": \"12011\",\r\n      \"state\": \"FL\",\r\n      \"country\": \"United States\"\r\n    },\r\n    \"primary_category_id\": 57,\r\n    \"secondary_category_id\": 45,\r\n    \"keywords\": [\r\n      \"My Business for Everything\",\r\n      \"By Business\",\r\n      \"Only Business\"\r\n    ],\r\n    \"external_id\": \"1237\"\r\n  }\r\n}"
headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("POST", url, data=payload, headers=headers)
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://apis.buzzboard.com/v4.0/records/enrich"

	payload := strings.NewReader("{\r\n  \"data\": {\r\n    \"business_name\": \"Design Services Company\",\r\n    \"website\": \"http://www.designservice.com\",\r\n    \"phone\": \"(541) 754-3010\",\r\n    \"contact_info\": {\r\n      \"first_name\": \"Mathew\",\r\n      \"last_name\": \"Cooper\",\r\n      \"email\": \"mathew@designservice.com\",\r\n      \"mobile\": \"5417543011\",\r\n      \"title\": \"Mr\",\r\n      \"phone\": \"(541) 754-3010\"\r\n    },\r\n    \"address\": {\r\n      \"line1\": \"151th Street\",\r\n      \"city\": \"Miami\",\r\n      \"zip\": \"12011\",\r\n      \"state\": \"FL\",\r\n      \"country\": \"United States\"\r\n    },\r\n    \"primary_category_id\": 57,\r\n    \"secondary_category_id\": 45,\r\n    \"keywords\": [\r\n      \"My Business for Everything\",\r\n      \"By Business\",\r\n      \"Only Business\"\r\n    ],\r\n    \"external_id\": \"1237\"\r\n  }\r\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse response = Unirest.post("https://apis.buzzboard.com/v4.0/records/enrich")
  .header("content-type", "application/json")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("cache-control", "no-cache")
  .body("{\r\n  \"data\": {\r\n    \"business_name\": \"Design Services Company\",\r\n    \"website\": \"http://www.designservice.com\",\r\n    \"phone\": \"(541) 754-3010\",\r\n    \"contact_info\": {\r\n      \"first_name\": \"Mathew\",\r\n      \"last_name\": \"Cooper\",\r\n      \"email\": \"mathew@designservice.com\",\r\n      \"mobile\": \"5417543011\",\r\n      \"title\": \"Mr\",\r\n      \"phone\": \"(541) 754-3010\"\r\n    },\r\n    \"address\": {\r\n      \"line1\": \"151th Street\",\r\n      \"city\": \"Miami\",\r\n      \"zip\": \"12011\",\r\n      \"state\": \"FL\",\r\n      \"country\": \"United States\"\r\n    },\r\n    \"primary_category_id\": 57,\r\n    \"secondary_category_id\": 45,\r\n    \"keywords\": [\r\n      \"My Business for Everything\",\r\n      \"By Business\",\r\n      \"Only Business\"\r\n    ],\r\n    \"external_id\": \"1237\"\r\n  }\r\n}")
  .asString();
{
  "record_id": 1,
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "score": {
      "value": "P",
      "color": "#0000E9"
    },
    "external_id": "1237",
    "created_at": 1489750959,
    "updated_at": 1489750959
  }
}

Enrich Records - Batch

Enrich multiple records at a go and a callback URL that will be invoked by the API method you are calling.

https://apis.buzzboard.com/v4.0/records/enrichbulk

Parameters

Field Type Description
business_name Required

String

Name of the record.

website Required

String

Record website. Required unless city and state fields are provided.

phone

String

Record phone number.

contact_info

Object

Record contact information. For more information about the contact_info object see Contact Info.

address Required

Object

Record address information. For more information about the address object see Address.

primary_category_id

Number

Primary Category Id of the record. See Category List

secondary_category_id

Number

Secondary Category Id of the record. See Category List

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

callback_url Required

String

Callback URL to be invoked by the API method you're calling after it's done.

curl -X POST "https://apis.buzzboard.com/v4.0/records/enrichbulk"
-H "authorization: Bearer ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{ "data": { "records": [ { "business_name": "Dev Company", "website": "https://dev.com", "phone": "(908) 998-9898", "contact_info": { "first_name": "john", "last_name": "Mathew", "email": "johnmathew@gm.com", "mobile": "5417543011", "title": "Mr", "phone": "(541) 754-3010" }, "address": { "line1": "34 Old Compton Street", "city": "London", "zip": "12365", "state": "FL", "country": "United States" }, "primary_category_id": 57, "secondary_category_id": 45, "keywords": [ "My Business", "Business", "Only Business" ] }, { "business_name": "Dev2 Company", "website": "https://devcom.com", "phone": "(988) 998-9898", "contact_info": { "first_name": "johns", "last_name": "Mathews", "email": "johnmathesw@gm.com", "mobile": "5418543011", "title": "Mr", "phone": "(541) 754-8010" }, "address": { "line1": "34 Old Compton Street", "city": "London", "zip": "23654", "state": "FL", "country": "United States" }, "primary_category_id": 57, "secondary_category_id": 45, "keywords": [ "Business", "Dev Business", "Only Dev Business" ] } ], "callback_url": "https://requestb.in/176r7bl1", "owner_id": 1009 } }'
var request = require('request');

var options = { method: 'POST',
  url: 'https://apis.buzzboard.com/v4.0/records/enrichbulk',headers: 
   { 'cache-control': 'no-cache',
     authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' },
  body: 
   { data: 
      { records: 
         [ { business_name: 'Dev Company',
             website: 'https://dev.com',
             phone: '(908) 998-9898',
             contact_info: 
              { first_name: 'john',
                last_name: 'Mathew',
                email: 'johnmathew@gm.com',
                mobile: '5417543011',
                title: 'Mr',
                phone: '(541) 754-3010' },
             address: 
              { line1: '34 Old Compton Street',
                city: 'London',
                zip: '12365',
                state: 'FL',
                country: 'United States' },
             primary_category_id: 57,
             secondary_category_id: 45,
             keywords: [ 'My Business', 'Business', 'Only Business' ] },
           { business_name: 'Dev2 Company',
             website: 'https://devcom.com',
             phone: '(988) 998-9898',
             contact_info: 
              { first_name: 'johns',
                last_name: 'Mathews',
                email: 'johnmathesw@gm.com',
                mobile: '5418543011',
                title: 'Mr',
                phone: '(541) 754-8010' },
             address: 
              { line1: '34 Old Compton Street',
                city: 'London',
                zip: '23654',
                state: 'FL',
                country: 'United States' },
             primary_category_id: 57,
             secondary_category_id: 45,
             keywords: [ 'Business', 'Dev Business', 'Only Dev Business' ] } ],
        callback_url: 'https://requestb.in/176r7bl1',
        owner_id: 1009 } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  
});
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/records/enrichbulk");
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array("cache-control" => "no-cache",
  "authorization" => "Bearer ACCESS_TOKEN",
  "content-type" => "application/json"
));

$request->setBody("{
"data": {
    "records": [
      {
        "business_name": "Dev Company",
        "website": "https://dev.com",
        "phone": "(908) 998-9898",
        "contact_info": {
          "first_name": "john",
          "last_name": "Mathew",
          "email": "johnmathew@gm.com",
          "mobile": "5417543011",
          "title": "Mr",
          "phone": "(541) 754-3010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "12365",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "My Business",
          "Business",
          "Only Business"
        ]
      },
      {
        "business_name": "Dev2 Company",
        "website": "https://devcom.com",
        "phone": "(988) 998-9898",
        "contact_info": {
          "first_name": "johns",
          "last_name": "Mathews",
          "email": "johnmathesw@gm.com",
          "mobile": "5418543011",
          "title": "Mr",
          "phone": "(541) 754-8010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "23654",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "Business",
          "Dev Business",
          "Only Dev Business"
        ]
      }
    ],
    "callback_url": "https://requestb.in/176r7bl1",
    "owner_id": 1009
  }
}");

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/records/enrichbulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"
request.body = "{\r\n\"data\": {\r\n    \"records\": [\r\n      {\r\n        \"business_name\": \"Dev Company\",\r\n        \"website\": \"https://dev.com\",\r\n        \"phone\": \"(908) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"john\",\r\n          \"last_name\": \"Mathew\",\r\n          \"email\": \"johnmathew@gm.com\",\r\n          \"mobile\": \"5417543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-3010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"12365\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"My Business\",\r\n          \"Business\",\r\n          \"Only Business\"\r\n        ]\r\n      },\r\n      {\r\n        \"business_name\": \"Dev2 Company\",\r\n        \"website\": \"https://devcom.com\",\r\n        \"phone\": \"(988) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"johns\",\r\n          \"last_name\": \"Mathews\",\r\n          \"email\": \"johnmathesw@gm.com\",\r\n          \"mobile\": \"5418543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-8010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"23654\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"Business\",\r\n          \"Dev Business\",\r\n          \"Only Dev Business\"\r\n        ]\r\n      }\r\n    ],\r\n    \"callback_url\": \"https://requestb.in/176r7bl1\",\r\n    \"owner_id\": 1009\r\n  }\r\n}"

response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/records/enrichbulk"

payload = "{\r\n\"data\": {\r\n    \"records\": [\r\n      {\r\n        \"business_name\": \"Dev Company\",\r\n        \"website\": \"https://dev.com\",\r\n        \"phone\": \"(908) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"john\",\r\n          \"last_name\": \"Mathew\",\r\n          \"email\": \"johnmathew@gm.com\",\r\n          \"mobile\": \"5417543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-3010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"12365\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"My Business\",\r\n          \"Business\",\r\n          \"Only Business\"\r\n        ]\r\n      },\r\n      {\r\n        \"business_name\": \"Dev2 Company\",\r\n        \"website\": \"https://devcom.com\",\r\n        \"phone\": \"(988) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"johns\",\r\n          \"last_name\": \"Mathews\",\r\n          \"email\": \"johnmathesw@gm.com\",\r\n          \"mobile\": \"5418543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-8010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"23654\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"Business\",\r\n          \"Dev Business\",\r\n          \"Only Dev Business\"\r\n        ]\r\n      }\r\n    ],\r\n    \"callback_url\": \"https://requestb.in/176r7bl1\",\r\n    \"owner_id\": 1009\r\n  }\r\n}"
headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("POST", url, data=payload, headers=headers)
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://apis.buzzboard.com/v4.0/records/enrichbulk"

	payload := strings.NewReader("{\r\n\"data\": {\r\n    \"records\": [\r\n      {\r\n        \"business_name\": \"Dev Company\",\r\n        \"website\": \"https://dev.com\",\r\n        \"phone\": \"(908) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"john\",\r\n          \"last_name\": \"Mathew\",\r\n          \"email\": \"johnmathew@gm.com\",\r\n          \"mobile\": \"5417543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-3010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"12365\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"My Business\",\r\n          \"Business\",\r\n          \"Only Business\"\r\n        ]\r\n      },\r\n      {\r\n        \"business_name\": \"Dev2 Company\",\r\n        \"website\": \"https://devcom.com\",\r\n        \"phone\": \"(988) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"johns\",\r\n          \"last_name\": \"Mathews\",\r\n          \"email\": \"johnmathesw@gm.com\",\r\n          \"mobile\": \"5418543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-8010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"23654\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"Business\",\r\n          \"Dev Business\",\r\n          \"Only Dev Business\"\r\n        ]\r\n      }\r\n    ],\r\n    \"callback_url\": \"https://requestb.in/176r7bl1\",\r\n    \"owner_id\": 1009\r\n  }\r\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse response = Unirest.post("https://apis.buzzboard.com/v4.0/records/enrichbulk")
  .header("content-type", "application/json")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("cache-control", "no-cache")
  .body("{\r\n\"data\": {\r\n    \"records\": [\r\n      {\r\n        \"business_name\": \"Dev Company\",\r\n        \"website\": \"https://dev.com\",\r\n        \"phone\": \"(908) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"john\",\r\n          \"last_name\": \"Mathew\",\r\n          \"email\": \"johnmathew@gm.com\",\r\n          \"mobile\": \"5417543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-3010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"12365\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"My Business\",\r\n          \"Business\",\r\n          \"Only Business\"\r\n        ]\r\n      },\r\n      {\r\n        \"business_name\": \"Dev2 Company\",\r\n        \"website\": \"https://devcom.com\",\r\n        \"phone\": \"(988) 998-9898\",\r\n        \"contact_info\": {\r\n          \"first_name\": \"johns\",\r\n          \"last_name\": \"Mathews\",\r\n          \"email\": \"johnmathesw@gm.com\",\r\n          \"mobile\": \"5418543011\",\r\n          \"title\": \"Mr\",\r\n          \"phone\": \"(541) 754-8010\"\r\n        },\r\n        \"address\": {\r\n          \"line1\": \"34 Old Compton Street\",\r\n          \"city\": \"London\",\r\n          \"zip\": \"23654\",\r\n          \"state\": \"FL\",\r\n          \"country\": \"United States\"\r\n        },\r\n        \"primary_category_id\": 57,\r\n        \"secondary_category_id\": 45,\r\n        \"keywords\": [\r\n          \"Business\",\r\n          \"Dev Business\",\r\n          \"Only Dev Business\"\r\n        ]\r\n      }\r\n    ],\r\n    \"callback_url\": \"https://requestb.in/176r7bl1\",\r\n    \"owner_id\": 1009\r\n  }\r\n}")
  .asString();
{
  "data": {
    "job_id": "lXERIj1xZKIbFMIR"
  }
}

Enrich Records - Contact Info

The contact_info object is used across all Records APIs.

Field Type Description
first_name

String

First name of the contact.

last_name

String

Last name of the contact.

email

String

Email address of the contact.

phone

String

Phone number of the contact.

mobile

String

Mobile number of the contact.

title

String

Title of the contact.

Enrich Records - Address

The address object is used across all Records APIs.

Field Type Description
line1

String

Number, street, suite, or apartment number.

city Required

String

City name.

state Required

String

State name.

zip Required

String

Postal code.

country

String

Country name.

Enrich Records - NAP

Get name, address, phone number & categories for an individual business.

http://api2.buzzboard.com/nap/get-nap-info

Parameters

Field Type Description
Url Required

String

Website url.

country_code

String

Country code

Creates a new record 'nbuzzboard.com' with country_code 1.

curl -X POST "http://api2.buzzboard.com/nap/get-nap-info"
-H "authorization: Bearer ACCESS_TOKEN"
-H "cache-control: no-cache"
-H "content-type: application/json"
-F Url=buzzboard.com
var options = {
    "method": "POST",
    "hostname":  "api2.buzzboard.com" ,
    "path":  "/nap/get-nap-info",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer ",
    }
   };

   var req = http.request(options, function (res) {
    var chunks = [];

    res.on("data", function (chunk) {
      chunks.push(chunk);
    });

    res.on("end", function () {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
    });
   });

   req.write(JSON.stringify({ url: "buzzboard.com" }));
   req.end();
  $request = new HttpRequest();
  $request->setUrl("http://api2.buzzboard.com/nap/get-nap-info");
  $request->setMethod(HTTP_METH_POST);
  $request->setHeaders(array("cache-control" => "no-cache",
    "authorization" => "Bearer ACCESS_TOKEN",
    "content-type" => "application/json"
  ));

  $request->setBody("JSON.stringify({ url: "buzzboard.com" })");

  try {
    $response = $request->send();

    echo $response->getBody();
  } catch (HttpException $ex) {
    echo $ex;
  }
require "uri"
require "net/http"

url = URI("http://api2.buzzboard.com/nap/get-nap-info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request.body = JSON.stringify({ url: "buzzboard.com" })

response = http.request(request)
puts response.read_body
import requests

url = "http://api2.buzzboard.com/nap/get-nap-info"

payload = JSON.stringify({ url: "buzzboard.com" })
headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("POST", url, data=payload, headers=headers)
package main

import (
        "fmt"
        "strings"
        "net/http"
        "io/ioutil"
)

func main() {

        url := "http://api2.buzzboard.com/nap/get-nap-info"

        payload := strings.NewReader(JSON.stringify({ url: "buzzboard.com" }))

        req, _ := http.NewRequest("POST", url, payload)

        req.Header.Add("content-type", "application/json")
        req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
        req.Header.Add("cache-control", "no-cache")

        res, _ := http.DefaultClient.Do(req)

        defer res.Body.Close()
        body, _ := ioutil.ReadAll(res.Body)

        fmt.Println(res)
        fmt.Println(string(body))

}
HttpResponse response = Unirest.post("http://api2.buzzboard.com/nap/get-nap-info")
    .header("content-type", "application/json")
    .header("authorization", "Bearer ACCESS_TOKEN")
    .header("cache-control", "no-cache")
    .body(JSON.stringify({ url: "buzzboard.com" }))
    .asString();
{
  "meta": {
    "status_code": "200",
    "response_time": "518 ms"
  },
  "response": {
    "requested_url": "http://buzzboard.com/",
    "final_url": "www.buzzboard.com",
    "website_status": 200,
    "phone_numbers": [
      "4159066934"
    ],
    "address_info": [
      {
        "city": "San Francisco",
        "state": "CA",
        "zipCode": "94104",
        "country": "us",
        "streetName": "180 Sansome Street"
      }
    ],
    "categories": [
      "Advertising",
      "Marketing Programs & Services"
    ],
    "domain_validation": {
      "is_directory": "",
      "website_builder": "",
      "parked_site": "",
      "under_construction": ""
    }
  }
}

Categories

The categories you add to the business record

PROPERTIES

The following properties are for use with the Categories API.

Field Type Description
id

Number

Unique identifier of the Category.

name

String

Unique name of the Category.

Categories - List

Retrieves a list of categories

https://apis.buzzboard.com/v4.0/categories

Returns a list of all categories available.

curl -X GET "https://apis.buzzboard.com/v4.0/categories"
-H "authorization: Bearer ACCESS_TOKEN
var request = require('request');
var options = { 
method: 'GET', 
url: 'https://apis.buzzboard.com/v4.0/categories',headers: 
   { 'cache-control': 'no-cache',
     authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' },
 request(options, function (error, response, body) {
 if (error) throw new Error(error);
}
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/categories");
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array("cache-control" => "no-cache",
  "authorization" => "Bearer ACCESS_TOKEN",
  "content-type" => "application/json"
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"
response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/categories"


headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("GET", url, headers=headers))
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://apis.buzzboard.com/v4.0/categories"
	
	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)
        
        req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse response = Unirest.get("https://apis.buzzboard.com/v4.0/categories")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("content-type", "application/json")
  .header("cache-control", "no-cache")
  .asString();
{
  "data": [
    {
      "id": 1,
      "name": "Abbey"
    },
    {
      "id": 2,
      "name": "Abortion Clinic"
    }
  ],
  "meta": {
    "count": 2
  }
}

Record Signals

Enriches the records with the multiple signals and are assigned with a grade

Record Signals - Signals

Retrieves the required record signals individually or by the categorized group.

https://apis.buzzboard.com/v4.0/profile/signals

Parameters

Field Type Description
record_id Required

Number

The unique identifier of the record.Use this API to enrich the records with all the signals.(e.g.) https://apis.buzzboard.com/v4.0/profile/signals?record_id=1

signal_key

Json

Use this API to enrich the records by required signals that are categorized under each of the groups.(e.g.) https://apis.buzzboard.com/v4.0/profile/signals?record_id=1&signal_key={"media":"","social_media_presence_analysis":["facebook_business_page","twitter_business_profile"]}(OR)

Use this API to enrich the records by all signals that are categorized under each of the groups. (e.g.) https://apis.buzzboard.com/v4.0/profile/signals?record_id=1&signal_key=["media","social_media_presence_analysis"] Refer Schema API for signals and signals group keys.

Returns list of all record signals.

curl -X GET "https://apis.buzzboard.com/v4.0/profile/signals?record_id=3672099"
-H "authorization: Bearer ACCESS_TOKEN"
var request = require('request');

var options = { method: 'GET',
url: 'https://apis.buzzboard.com/v4.0/profile/signals',
qs: { prospect_id: '3672099' },
'headers: 
   { 'cache-control': 'no-cache',
      authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' },
 request(options, function (error, response, body) {
  if (error) throw new Error(error);
}
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/profile/signals");
$request->setMethod(HTTP_METH_GET);
$request->setQueryData(array(
  "prospect_id" => "3672099"
));

$request->setHeaders(array(
  "cache-control" => "no-cache",
  "content-type" => "application/json",
  "authorization" => "Bearer ACCESS_TOKEN"
));
try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/profile/signals?prospect_id=3672099")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"
response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/profile/signals"

querystring = {"prospect_id":"3672099"}

headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("GET", url, headers=headers, params=querystring)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

    url := "https://apis.buzzboard.com/v4.0/profile/signals?prospect_id=3672099"

	req, _ := http.NewRequest("GET", url, nil)
	
	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)


}
HttpResponse response = Unirest.get("https://apis.buzzboard.com/v4.0/profile/signals?prospect_id=3672099")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("content-type", "application/json")
  .header("cache-control", "no-cache")
  .asString();
{
  "sections": [
    {
      "key": "keyword_analysis",
      "name": "Keyword Analysis",
      "description": "An analysis of the keywords used in the website to determine their rank.",
      "section_brief_desc": "Keyword Analysis lets you know whether your keyword(s) are showing results on search.",
      "grade": {
        "value": 100,
        "color": "#ff00ff"
      },
      "signals": [
        {
          "key": null,
          "name": "U.S. Department of Justice",
          "description": null,
          "data": {
            "google": "1",
            "yahoo": "1",
            "bing": "1"
          }
        }
      ]
    },
    {
      "key": "media",
      "name": "Advertising",
      "description": "How much does the business spend on various modes of advertising?",
      "section_brief_desc": "Paid Advertising statistics.",
      "grade": {
        "value": 100,
        "color": "#ff00ff"
      },
      "signals": [
        {
          "key": "dp_google_adword",
          "name": "Google AdWords",
          "description": "Google AdWords",
          "data": {
            "Presence": false,
            "Est. Ad Spend/mo": "-"
          }
        },
        {
          "key": "dp_bing_adword",
          "name": "Bing Ads",
          "description": "Bing Ads",
          "data": {
            "Presence": false,
            "Est. Ad Spend/mo": "-"
          }
        }
      ]
    }
  ],
  "meta": {
    "last_generated": 1492584540,
    "record_id": 1
  }
}

Record Signals - Schema

Utilize the Schema API to get the required signals individually or by group.

https://apis.buzzboard.com/v4.0/profile/schema

Returns list of all record signals.

curl -X GET "https://apis.buzzboard.com/v4.0/profile/schema"
-H "authorization: Bearer ACCESS_TOKEN"
var request = require('request');

var options = { method: 'GET',
  url: 'https://apis.buzzboard.com/v4.0/profile/schema',
  headers: 
   { 'cache-control': 'no-cache',
      authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' } };
request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/profile/schema");
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  "cache-control" => "no-cache",
  "content-type" => "application/json",
  "authorization" => "Bearer ACCESS_TOKEN"
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/profile/schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"

response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/profile/schema"

headers = {
     "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("GET", url, headers=headers)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://apis.buzzboard.com/v4.0/profile/schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse response = Unirest.get("https://apis.buzzboard.com/v4.0/profile/schema")
  .header("authorization", "Bearer 8ab94b04-5c20-307d-902f-275bb0089b22")
  .header("content-type", "application/json")
  .header("cache-control", "no-cache")
  .header("postman-token", "66c2113d-d5e8-7f08-09fc-a26c7159ac3a")
  .asString();
{
  "sections": [
    {
      "key": "mobile_website_presence",
      "name": "Multi-Screen Compatibility",
      "signals": [
        {
          "key": "availability",
          "name": "Mobile Friendly"
        },
        {
          "key": "responsive",
          "name": "Responsive Design"
        },
        {
          "key": "mobile_pagespeed_score",
          "name": "PageSpeed"
        }
      ]
    },
    {
      "key": "media",
      "name": "Advertising",
      "signals": [
        {
          "key": "dp_google_adword",
          "name": "Google Ads"
        },
        {
          "key": "adbeat_display_ads",
          "name": "Display Ads"
        }
      ]
    },
    {
      "key": "seo_analysis",
      "name": "SEO Analysis",
      "signals": [
        {
          "key": "robots_txt",
          "name": "Robots.txt"
        },
        {
          "key": "sitemap_xml",
          "name": "Sitemap.xml"
        },
        {
          "key": "title_tag_optimization",
          "name": "Title Tag Compliance"
        },
        {
          "key": "location_in_title",
          "name": "Location In Title"
        },
        {
          "key": "unique_title",
          "name": "Unique Title"
        },
        {
          "key": "meta_description_optimization",
          "name": "Meta Description Compliance"
        },
        {
          "key": "headings",
          "name": "Headings Included"
        },
        {
          "key": "image_optimization",
          "name": "Image Alt Text"
        },
        {
          "key": "www_resolve",
          "name": "Domain Redirection"
        },
        {
          "key": "no_frames_used",
          "name": "Frames Excluded"
        },
        {
          "key": "no_flash_used",
          "name": "Flash Excluded"
        },
        {
          "key": "backlinks",
          "name": "Backlinks"
        },
        {
          "key": "google_page_rank",
          "name": "MOZ Rank"
        },
        {
          "key": "text_content",
          "name": "Text Content"
        },
        {
          "key": "domain_age",
          "name": "Domain Age"
        },
        {
          "key": "richsnippets",
          "name": "Rich Snippets"
        },
        {
          "key": "friendly_urls",
          "name": "SEF URL"
        },
        {
          "key": "sitemap_html",
          "name": "Sitemap.html"
        },
        {
          "key": "trust_flow",
          "name": "Trust Flow"
        }
      ]
    },
    {
      "key": "keyword_analysis",
      "name": "Keyword Analysis (SEO)"
    },
    {
      "key": "local_analysis",
      "name": "Content Analysis",
      "signals": [
        {
          "key": "local_phone_number",
          "name": "Local Phone Number"
        },
        {
          "key": "address_on_homepage",
          "name": "Address on Homepage"
        },
        {
          "key": "map_directions",
          "name": "Map & Directions"
        },
        {
          "key": "blog",
          "name": "Blog"
        },
        {
          "key": "contact_us",
          "name": "Contact Us"
        },
        {
          "key": "privacy_policy",
          "name": "Privacy Policy"
        },
        {
          "key": "gallery",
          "name": "Gallery"
        },
        {
          "key": "news_letter",
          "name": "Newsletter"
        }
      ]
    },
    {
      "key": "infrastructure_robustness",
      "name": "Infrastructure Robustness",
      "signals": [
        {
          "key": "pagespeed_score",
          "name": "PageSpeed"
        },
        {
          "key": "caching_enabled",
          "name": "Caching Enabled"
        },
        {
          "key": "robustness_image_optimization",
          "name": "Image Size Optimization"
        },
        {
          "key": "file_compression",
          "name": "Text Compression"
        },
        {
          "key": "speed_optimized",
          "name": "Server Response Time"
        },
        {
          "key": "page_redirects",
          "name": "No Page Redirects"
        },
        {
          "key": "prioritize_visible_content",
          "name": "Prioritize Visible Content"
        },
        {
          "key": "iswordpress",
          "name": "Wordpress"
        },
        {
          "key": "ga_code",
          "name": "Google Analytics"
        },
        {
          "key": "secured_site",
          "name": "Sensitive Information Security"
        }
      ]
    },
    {
      "key": "social_media_presence_analysis",
      "name": "Social Media Presence",
      "signals": [
        {
          "key": "facebook_business_page",
          "name": "Facebook Business Page"
        },
        {
          "key": "twitter_business_profile",
          "name": "Twitter Business Account"
        },
        {
          "key": "youtube_business_channel",
          "name": "YouTube Channel"
        },
        {
          "key": "linkedin_company_profile",
          "name": "LinkedIn Company Page"
        }
      ]
    },
    {
      "key": "local_business_presence",
      "name": "Local Business Presence",
      "signals": [
        {
          "key": "google_places",
          "name": "Google Maps"
        },
        {
          "key": "citysearch",
          "name": "Citysearch"
        },
        {
          "key": "bing_local",
          "name": "Bing Local"
        },
        {
          "key": "yellow_pages",
          "name": "YP.com"
        },
        {
          "key": "nokia_places",
          "name": "Here Maps"
        }
      ]
    },
    {
      "key": "commerce_tools",
      "name": "Commerce Tools",
      "signals": [
        {
          "key": "coupons",
          "name": "Coupons"
        }
      ]
    },
    {
      "key": "section_reviews",
      "name": "Reviews",
      "signals": [
        {
          "key": "review_negative",
          "name": "Negative"
        },
        {
          "key": "review_neutral",
          "name": "Neutral"
        },
        {
          "key": "review_positive",
          "name": "Positive"
        }
      ]
    }
  ],
  "meta": [
  ]
}

Jobs

Get the processing status of the records that you have pushed for enrichment

PROPERTIES

The following properties are related to Jobs API.

Field Type Description
job_id

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

Jobs - Get Details

Retrieves the records processing status.

https://apis.buzzboard.com/v4.0/jobs?job_id={id}&module_id={moduleName}

Parameters

Field Type Description
job_id Required

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

module_id

String

The name of the module.(e.g.) ?module_id=enrichbulk Possible module idsenrichbulk Default value is enrichbulk

curl -X GET "https://apis.buzzboard.com/v4.0/jobs?job_id=MCmuwDbqaw3H9zp7&module_id=enrichbulk" 
-H "Authorization: Bearer $ACCESS_TOKEN"
var request = require('request');

var options = { method: 'GET',
url: 'https://apis.buzzboard.com/v4.0/jobs',
qs: { job_id: 'MCmuwDbqaw3H9zp7', module_id: 'enrichbulk' },
'headers: 
   { 'cache-control': 'no-cache',
      authorization: 'Bearer ACCESS_TOKEN',
     'content-type': 'application/json' },
 request(options, function (error, response, body) {
  if (error) throw new Error(error);
}
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/jobs");
$request->setMethod(HTTP_METH_GET);
$request->setQueryData(array(
  "job_id" => "MCmuwDbqaw3H9zp7",
  "module_id" => "enrichbulk"
))

$request->setHeaders(array(
  "cache-control" => "no-cache",
  "content-type" => "application/json",
  "authorization" => "Bearer ACCESS_TOKEN"
));
try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/jobs?job_id=MCmuwDbqaw3H9zp7&module_id=enrichbulk"")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = "application/json"
request["authorization"] = "Bearer ACCESS_TOKEN"
request["cache-control"] = "no-cache"
response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/jobs"

querystring = {"job_id":"MCmuwDbqaw3H9zp7","module_id":"enrichbulk"}

headers = {
    "content-type": "application/json",
    "authorization": "Bearer ACCESS_TOKEN",
    "cache-control": "no-cache"
    }

response = requests.request("GET", url, headers=headers, params=querystring)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

    url := "https://apis.buzzboard.com/v4.0/jobs?job_id=MCmuwDbqaw3H9zp7&module_id=enrichbulk"

	req, _ := http.NewRequest("GET", url, nil)
	
	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)


}
HttpResponse response = Unirest.get("https://apis.buzzboard.com/v4.0/jobs?job_id=MCmuwDbqaw3H9zp7&module_id=enrichbulk")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("content-type", "application/json")
  .header("cache-control", "no-cache")
  .asString();
{
  "data": {
    "status": "Completed",
    "id": "MCmuwDbqaw3H9zp7",
    "created_at": 1492493949,
    "count": {
      "total": 2,
      "completed": 1,
      "inqueue": null,
      "failed": 1
    }
  }
}

Report data error

You can send back records that you may think are erroneous and we will credit that back to you.

Report data error - Report

https://apis.buzzboard.com/v4.0/error/report

Parameters

Field Type Description
record_id Required

Number

The unique identifier of the record.

type Required

Array

Name of the type E.g.:{Problem,Data issue}

signals

Array

List of signal keys, typically "key" that is returning from "Record Signals - Signals" API.

message

String

Creates a new report

curl -X POST "https://apis.buzzboard.com/v4.0/error/report"
-H "authorization: Bearer ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{ "data": { "record_id": 147, "type": ["Problem","Data issue"], "signals": ["responsive_design","media"], "message": "sample description for error report" } }'
var request = require('request');

var options = { method: 'POST',
  url: 'https://apis.buzzboard.com/v4.0/error/report',
  headers: 
   { 
     'cache-control': 'no-cache',
     'content-type': 'application/json',
     authorization: 'Bearer ACCESS_TOKEN' },
  body: 
   { data: 
      { record_id: 147,
        type: [ 'Problem', 'Data issue' ],
        signals: [ 'responsive_design', 'media' ],
        message: 'sample description for error report' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
$request = new HttpRequest();
$request->setUrl("https://apis.buzzboard.com/v4.0/error/report");
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array("cache-control" => "no-cache",
  "authorization" => "Bearer ACCESS_TOKEN",
  "content-type" => "application/json"));

$request->setBody("{
  "data": {
    "record_id": 147,
    "type": ["Problem","Data issue"],
    "signals": ["responsive_design","media"],
    "message": "sample description for error report"
  }
}");

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
require "uri"
require "net/http"

url = URI("https://apis.buzzboard.com/v4.0/error/report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = "Bearer ACCESS_TOKEN"
request["content-type"] = "application/json"
request["cache-control"] = "no-cache"
request.body = "{\r\n  \"data\": {\r\n    \"record_id\": 147,\r\n    \"type\": [\"Problem\",\"Data issue\"],\r\n    \"signals\": [\"responsive_design\",\"media\"],\r\n    \"message\": \"sample description for error report\"\r\n  }\r\n}"

response = http.request(request)
puts response.read_body
import requests

url = "https://apis.buzzboard.com/v4.0/error/report"

payload = "{\r\n  \"data\": {\r\n    \"record_id\": 147,\r\n    \"type\": [\"Problem\",\"Data issue\"],\r\n    \"signals\": [\"responsive_design\",\"media\"],\r\n    \"message\": \"sample description for error report\"\r\n  }\r\n}"
headers = {
    "authorization": "Bearer ACCESS_TOKEN",
    "content-type": "application/json",
    "cache-control": "no-cache"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://apis.buzzboard.com/v4.0/error/report"

	payload := strings.NewReader("{\r\n  \"data\": {\r\n    \"record_id\": 147,\r\n    \"type\": [\"Problem\",\"Data issue\"],\r\n    \"signals\": [\"responsive_design\",\"media\"],\r\n    \"message\": \"sample description for error report\"\r\n  }\r\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "Bearer ACCESS_TOKEN")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse response = Unirest.post("https://apis.buzzboard.com/v4.0/error/report")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .header("content-type", "application/json")
  .header("cache-control", "no-cache")
  .body("{\r\n  \"data\": {\r\n    \"record_id\": 147,\r\n    \"type\": [\"Problem\",\"Data issue\"],\r\n    \"signals\": [\"responsive_design\",\"media\"],\r\n    \"message\": \"sample description for error report\"\r\n  }\r\n}")
  .asString();
{
  "status": 200,
  "message": "Success"
}

Errors

Returns standard HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx indicate an error with the provided information, and codes in the 5xx range indicate a server-side error. Contact your system administrator for additional information or for response codes not listed here.

Http status codes

Code Message Description
200 OK Everything worked as expected.
201 Created Everything worked as expected. Returned instead of 200 if your operation creates a new resource.
204 No Content Everything worked as expected. The response includes an empty body.
400 Bad Request Returned whenever the request is missing required information or is malformed in another way, e.g. the payload is malformed.
401 Unauthorized The API consumer credentials are invalid.
403 Forbidden The request has been refused because of insufficient user access privileges.
404 Not Found The requested resource could not be found.
405 Method Not Allowed The API consumer tried to access an endpoint with an invalid HTTP method, e.g. using PUT on a read-only resource.
408 Request Timeout Request Timeout.
429 Too Many Requests The rate limit was exceeded and access is temporarily blocked.
500 Internal Server Error Something went wrong on server side.
501 Not Implemented Not implemented.

We are always open to feedback, drop an email to support@buzzboard.com and let us know what you want to see from the SMBStreams API.

© 2019 BuzzBoard, Inc