The Heardable API

Welcome to the MagicFirehose™

Need real-time brand data for over 800 variables, 25 industry categories, 2,200 NAICS categories, 73 countries, 33,000 zip codes, and 15 million brands, including data on Facebook, FourSquare, Google Plus, Twitter, Vimeo, YouTube, plus over 100 other social networks? The Heardable MagicFirehose™ Application Programming Interface (API) provides access to discrete data feeds, plus Heardable global, local and category rankings, worldwide.

The current API version is v3.1. Version upgrades are automatic - you do not need to send the version with your request. All Heardable MagicFirehose™ The Heardable MagicFirehose™ API uses REST: all requests must be authenticated. An API key is required. Data is returned in JSON format. External data sources are accessed using OAuth, where supported. You may obtain an API key by calling 1-888-520-0034 or sending an email to marketing@heardable.com.


MagicFirehose™ v3.1 was released on June 11th, 2013. Added features include:

  1. Support for multiple social handles for all brands and any social network
  2. StackOverflow, Pinterest, SoundCloud, Kickstarter, and Indiegogo support
  3. Heardable Industry Category lookup and filtering support
  4. Twitter API v1.1 support
All scheduled/daily scan functions are working normally. No issues have been reported re any API calls.

Classes

/brandBrand profile, location, industry and comparative score
/chartReal-time streaming pie, line, bar, area, force, treemap and combination charts
/extReal-time data from third party APIs, such as Facebook, Linkedin, Twitter, Yahoo, YouTube, etc
/financeEDGAR filing, financial, and stock price information for listed companies and brands
/reportsReport creation, publishing and editing tools, and channel sales management
/siteSite audit results, including links and (basic) SEO analysis
/userBrand monitoring and report building credits, API handling, user Add/Edit/Delete methods
/utilAnalysis tools, including sentiment, keyword matching, data parsing, and updating

Brand

Brand Create Adds brand to Heardable, returns brand_id
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_domain>/<options>?key=<your_api_key>
Notes If scope = "master", and the brand domain is not found, a new brand profile is created, and the new brand_id is returned. If scope = "cluster", a new brand_id is created that references existing brand domains LIKE the submitted domain (i.e. this is used when adding a new physical location for a Starbucks, for example.)

Domain name must be url encoded. Optional additional data for the brand profile may be uploaded in the form of an array (i.e. ('brand_name' => "New Brand", 'address' => "123 Smith St", 'city' => "Houston", 'state' => "TX")) using brand profile keys (see Profile below.) Method returns false if existing domain found and scope = "master".

Example http://www.magicfirehose.com/api/brand/brand_create/master/my-unique-site.com/options?key=<your_api_key>
Response (JSON)
{
    "brand_id": "15709928",
    "brand_domain": "my-unique-site.com",
    "active": "1",
    "redirect": "0",
    "cluster": "0",
    "action_taken": "brand_added"
}

Brand Exists Returns brand_id and brand_domain in JSON format if brand exists
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Finds brand_id based on domain or brand name. Domain name or brand name must be url encoded and included as first parameter under options (see example), just prior to your API key.
Example http://www.magicfirehose.com/api/brand/brand_exists/all/0/audi.com?key=<your_api_key>
Response (JSON)
{
  "brand_id": "529",
  "brand_domain": "audi.com",
  "active": "1",
  "redirect": "0",
  "cluster": "10910"
}

Brand Image Returns brand image in JSON format
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Finds primary uploaded image using brand_id. Scope ("all") and brand_id are required.
Example http://www.magicfirehose.com/api/brand/brand_image/all/537?key=<your_api_key>
Response (JSON)
{
  "url": "http:\/\/heardable.com\/images\/profile_thumbs\/539_6323.jpg"
}

Competitors Returns list of competitors based on industry (NAICS) code, geographical location, or both
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Requires scope (number of results), brand_id, network parameter (denotes heardable ("hd") or a target social network (i.e. "fb", "tw", "yt") Optional parameters may be blank or contain three integers separated by commas: "1,0,0" returns industry competitors; "0,1,0" returns local/geographic competitors in the smallest US unit (i.e. zip code); "1,1,1" returns competitors in your industry and location. "0,0,0" returns a non-filtered leaderboard (i.e. "The Facebook Top 100".)

Note: The competitors method is extremely flexible: an actual NAICS code may be used instead of "1" in combination with a "0" brand_id to get a "Top 100" list by industry (i.e. "711130, 0, 0"). Actual geocodes, such as zips or two character country codes may be used instead of a "1" in the second country parameter (i.e. "0,90210,0")

Meta information enables mapping of common names used by social networks ("Followers") to keys returned by the API call.

Charts Bar, Pie, Scatter, Treemap
Example http://magicfirehose.com/api/brand/competitors/10/11/tw/0,0,1?key=<your_api_key> http://www.magicfirehose.com/api/brand/competitors/10/11/tw/0,0,1.chart?value=score&label=brand_name&height=400&width=600&valueAlias=Followers&type=bar&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "network": "Twitter",
        "score_name": "Followers",
        "events_all_name": "Mentions All",
        "events_per_name": "Mentions"
    },
    "data": [
        {
            "score": 30453055,
            "events_all": 46957,
            "events_per": 0,
            "brand_id": 1772,
            "brand_domain": "ladygaga.com",
            "brand_category": "711130",
            "brand_name": "Lady Gaga",
            "brand_city": "New York",
            "brand_state": "NY",
            "brand_zip": "10023",
            "brand_country": "US",
            "latitude": "40.776475",
            "longitude": "-73.980592",
            "brand_screenshot": "http://heardable.com/images/profile_thumbs/1772_9840.jpg",
            "brand_image": "https://si0.twimg.com/profile_images/2604754943/ppyl91bmwgaq4rlwjc4e_bigger.png"
        },
        {
            "score": 29175091,
            "events_all": 691200,
            "events_per": 0,
            "brand_id": 63751,
            "brand_domain": "justinbiebermusic.com",
            "brand_category": "711130",
            "brand_name": "Justin Bieber",
            "brand_city": "New York",
            "brand_state": "NY",
            "brand_zip": "10019",
            "brand_country": "US",
            "latitude": "40.7621538",
            "longitude": "-73.986313",
            "brand_screenshot": "http://heardable.com/images/profile_thumbs/63751_1401.jpg",
            "brand_image": "https://si0.twimg.com/profile_images/2385531870/ffb6obdzkxc3pk7lvbw2_bigger.jpeg"
        },
        {
            "score": 27976853,
            "events_all": 83077,
            "events_per": 0,
            "brand_id": 1213384,
            "brand_domain": "katyperry.com",
            "brand_category": "711130",
            "brand_name": "Katy Perry",
            "brand_city": "Los Angeles",
            "brand_state": "CA",
            "brand_zip": "90069",
            "brand_country": "US",
            "latitude": "34.0882640",
            "longitude": "-118.37677",
            "brand_screenshot": "http://heardable.com/images/profile_thumbs/1213384_8973.jpg",
            "brand_image": "https://si0.twimg.com/profile_images/2180831191/Screen_shot_2012-04-29_at_9.34.13_PM_bigger.png"
        }...
    ]
}

Response (d3)

Connectedness Returns connected users from Twitter for a target brand over a given period of days; optional sentiment analysis provides color-coded graphing capabilities
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and brand_id are required parameters. Optional parameter accepts sentiment (-1, 0, 1), plus unix timestamps for minimum and maximum dates, separated by commas. If no sentiment stated, all results are returned. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Force
Example http://www.magicfirehose.com/api/brand/connectedness/50/344?key=<your_api_key>
http://www.magicfirehose.com/api/brand/connectedness/50/344.chart?type=force&width=600&height=600&valueAlias=Influencers&key=<your_api_key>
Response (JSON)
{
  "nodes": [
    {
      "name": "jonsamsel",
      "status": "Insurance industry brands are at a strategic inflection point http:\/\/t.co\/DQAwcUhm - Learn more at...",
      "send_time": "1346421017",
      "sentiment": 2,
      "fill_color": "#75A911"
    },
    {
      "name": "TraceyCrocker",
      "status": "Check out this SlideShare presentation : 20 Simple Rules of Social Business Success http:\/\/t.co\/RN5GFi5e",
      "send_time": "1346394302",
      "sentiment": 3,
      "fill_color": "#75A911"
    },
    {
      "name": "aeroyacht",
      "status": "RT @SelfStorageGuy: Thx for the mention! RT @heardable @AllSelfStorage @SelfStorageGuy The Top Self Storage Brands in America http:\/\/t.co\/PbQaKkA4",
      "send_time": "1346371659",
      "sentiment": 3,
      "fill_color": "#75A911"
    }...
  ],
  "links": [
    {
      "source": 1,
      "target": 0,
      "value": 1
    },
    {
      "source": 2,
      "target": 0,
      "value": 1
    },
    {
      "source": 3,
      "target": 0,
      "value": 1
    }...
  ]
}
Response (d3)

Finance - EDGAR Returns most recent publicly-available financial information for public companies in JSON format
Parameters http://www.magicfirehose.com/api/finance/<method>/<scope>/<cik>/<symbol>?key=<your_api_key>
Notes Method and (brand_id OR symbol) are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/finance/company_detail/all/0/GOOG?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "id": "1061",
        "exchange": "NASDAQ",
        "symbol": "GOOG",
        "company_name": "Google Inc.",
        "adr_tso": "n/a",
        "ipo_year": "2004",
        "sector": "Technology",
        "industry": "Computer Software: Programming, Data Processing",
        "cw_id": "0",
        "timestamp": "1350086400",
        "cik": "1288776"
    },
    "data": {
        "filer_id": "770299",
        "filing_id": "9668702",
        "cik": "1288776",
        "irs_number": "770493581",
        "conformed_name": "Google Inc.",
        "fiscal_year_end": "1231",
        "sic_code": "7370",
        "business_street_1": "1600 AMPHITHEATRE PARKWAY",
        "business_street_2": null,
        "business_city": "MOUNTAIN VIEW",
        "business_state": "CA",
        "business_zip": "94043",
        "mail_street_1": "1600 AMPHITHEATRE PARKWAY",
        "mail_street_2": null,
        "mail_city": "MOUNTAIN VIEW",
        "mail_state": "CA",
        "mail_zip": "94043",
        "form_type": null,
        "sec_act": null,
        "sec_file_number": null,
        "film_number": null,
        "former_name": null,
        "name_change_date": null,
        "state_of_incorporation": "DE",
        "business_phone": "650 623 4000",
        "match_name": "Google Inc",
        "incorp_country_code": "US",
        "incorp_subdiv_code": "DE",
        "cw_id": "35783",
        "year": "2012",
        "mail_raw_address": "1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW CA 94043",
        "business_raw_address": "1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW CA 94043",
        "bad_cik": "0",
        "sec_21": "1"
    },
    "filings": [
        {
            "filing_id": "7861430",
            "cik": "1288776",
            "year": "2010",
            "quarter": "1",
            "period_of_report": 20091231,
            "filing_date": "2010-02-12",
            "form_10k_url": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-10-030774.txt",
            "sec_21_url": "http://www.sec.gov/Archives/edgar/data/1288776/000119312510030774/dex2101.htm",
            "xbrl_instance": "http://www.sec.gov/Archives/edgar/data/1288776/000119312510030774/goog-20091231.xml",
            "edgar_summary": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-10-030774000119312510030774-index.htm"
        },
        {
            "filing_id": "8789888",
            "cik": "1288776",
            "year": "2011",
            "quarter": "1",
            "period_of_report": 20101231,
            "filing_date": "2011-02-11",
            "form_10k_url": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-11-032930.txt",
            "sec_21_url": "http://www.sec.gov/Archives/edgar/data/1288776/000119312511032930/dex2101.htm",
            "xbrl_instance": "http://www.sec.gov/Archives/edgar/data/1288776/000119312511032930/goog-20101231.xml",
            "edgar_summary": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-11-032930000119312511032930-index.htm"
        },
        {
            "filing_id": "9668702",
            "cik": "1288776",
            "year": "2012",
            "quarter": "1",
            "period_of_report": 20111231,
            "filing_date": "2012-01-26",
            "form_10k_url": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-12-025336.txt",
            "sec_21_url": "http://www.sec.gov/Archives/edgar/data/1288776/000119312512025336/d260164dex2101.htm",
            "xbrl_instance": "http://www.sec.gov/Archives/edgar/data/1288776/000119312512025336/goog-20111231.xml",
            "edgar_summary": "http://www.sec.gov/Archives/edgar/data/1288776/0001193125-12-025336000119312512025336-index.htm"
        }
    ],
    "financials": {
        "meta": {
            "cik": "1288776",
            "symbol": "GOOG",
            "period_of_report": "2011"
        },
        "income_statement": {
            "total_revenue": "37905000000",
            "cost_of_revenue": "13188000000",
            "gross_profit": 24717000000,
            "operating_expenses": 12975000000,
            "operating_income": "11742000000",
            "net_income": "9737000000"
        },
        "balance_sheet": {
            "current_assets": "52758000000",
            "long_term_assets": 19816000000,
            "total_assets": "72574000000",
            "current_liabilities": "8913000000",
            "long_term_liabilities": 54748000000,
            "total_liabilities": 63661000000,
            "shareholder_equity": "58145000000",
            "liabiities_and_shareholder_equity": "72574000000"
        }
    },
    "link_to_quote": "http://www.nasdaq.com/symbol/GOOG"
}

Finance - Stock Prices Returns stock prices info for public companies in JSON format from time of IPO
Parameters http://www.magicfirehose.com/api/finance/<method>/<scope>/<cik>/<symbol>?key=<your_api_key>
Notes Method and (brand_id OR symbol) are required parameters. Optional parameters can include min date and max date, separated by commas in YYYYMMDD format.
Charts Line, Cumulative Line, Multiline Zoom
Example http://www.magicfirehose.com/api/finance/historical_prices/all/0/AAPL?key=<your_api_key>
http://www.magicfirehose.com/api/finance/historical_prices/all/0/AAPL.chart?type=line&value=close&label=close&valueAlias=Closing+Price+AAPL&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Trade Data Historical",
        "brand_id": 0,
        "symbol": "AAPL"
    },
    "data": [
        {
            "date": 1351062000,
            "close": 616.83
        },
        {
            "date": 1351148400,
            "close": 609.54
        },
        {
            "date": 1351234800,
            "close": 604.00
        }...
    ]
}
Response (d3)

Geocode Update latitude and longitude information for target brand.
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>?key=<your_api_key>
Notes Method and brand_id are required parameters. Optional parameter may be set to "verbose" to view response data from selected geoding tool, otherwise options default to "simple".
Example http://www.magicfirehose.com/api/brand/geocode/all/11/simple?key=<your_api_key>
Response (JSON)
{
    "brand_id": "11",
    "address": "28545 Old Town Front Street, Ste 206",
    "city": "Temecula",
    "state": "CA",
    "zip": "92590",
    "country": "US",
    "latitude": "33.494456",
    "longitude": "-117.150119"
}

Keywords (Brand) Returns keywords associated with target brand
Parameters http://www.magicfirehose.com/api/<method>/<scope>/<brand_id>/<sort>?key=<your_api_key>
Notes Scope (number of words to show) and brand_id are required parameters. Results will be returned in random order unless an (optional) third parameter (ASC or DESC) is added.
Charts Wordcloud
Example http://www.magicfirehose.com/api/brand/keywords/250/104860/ASC?key=<your_api_key>
http://www.magicfirehose.com/api/brand/keywords/250/104860.chart?type=wordcloud&valueAlias= &key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Word Cloud",
        "brand_id": "104860"
    },
    "data": [
        "latest",
        "details",
        "find",
        "website",
        "collections",
        "worldwide",
        "information",
        "contact",
        "press",
        "stockists",
        "Beckham",
        "Victoria",
        "evening dress",
        "fashion",
        "collection",
        "dresses",
        "limited edition",
        "designer dresses",
        "Official",
        "accessories",
        "denim",
        "Victoria Beckham",
        "find"...
    ]
}
Response (d3)

Keywords (Industry) Returns keywords associated with a target industry category
Parameters http://www.magicfirehose.com/api/<method>/<scope>/<naics_id>/<sort>?key=<your_api_key>
Notes Scope (number of words to show) and naics_id (i.e. 721110) are required parameters. Results will be returned in random order unless an (optional) third parameter (ASC or DESC) is added.
Charts Wordcloud
Example http://www.magicfirehose.com/api/brand/keywords_industry/250/104860/ASC?key=<your_api_key>
http://www.magicfirehose.com/api/brand/keywords_industry/250/104860.chart?type=wordcloud&valueAlias= &key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Keywords (Industry)",
        "naics_id": "621111",
	"category": "621111 Offices of Physicians (except Mental Health Specialists)"
    },
    "data": [
        "abdomen",
        "abdominal",
        "absorbs",
        "accident",
        "adolescent",
        "aesthetic",
        "aesthetics"...
    ]
}
Response (d3)

Locations Returns all available location information for known outlets and offices in JSON format
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Scope ("all") and brand_id are required parameters. Optional parameters are not supported. Latitude and longitude information is supplied for all entries to enable easy mapping.
Example http://www.magicfirehose.com/api/brand/locations/all/537?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Locations",
        "brand_id": "1",
        "brand_name": "Backcountry"
    },
    "data": [
        {
            "address": "1678 West Redstone Center Drive, Sui",
            "city": "Park City",
            "state": "UT",
            "zip": "84098",
            "country": "US",
            "lat": "40.74350",
            "lon": "-111.54683"
        },
        {
            "address": "2607 S 3200 W # A",
            "city": "West Valley",
            "state": "UT",
            "zip": "84119",
            "country": "US",
            "lat": "40.71395",
            "lon": "-111.96755"
        },
        {
            "address": "275 Valencia",
            "city": "Brea",
            "state": "California",
            "zip": "92823",
            "country": "US",
            "lat": "33.91436",
            "lon": "-117.85151"
        }
    ]
}

News Returns most recent press releases and news articles for target brand
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method and brand_id are required parameters.
Example http://www.magicfirehose.com/api/brand/news/all/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "News Releases",
        "brand_id": 11
    },
    "data": [
        {
            "source": "OneNewsPage.com",
            "title": "The World's 10 Best Hotel Chains Revealed In New Heardable ...",
            "url": "http://www.onenewspage.com/n/Press+Releases/74rahc4rc/The-World-10-Best-Hotel-Chains-Revealed.htm"
        },
        {
            "source": "Business Wire",
            "title": "element14 and Newark rank top in Online Brand Health ...",
            "url": "http://eon.businesswire.com/news/eon/20111102005997/en/element14/Heardable-inc/Premier-Farnell"
        },
        {
            "source": "OneNewsPage.com",
            "title": "Delta Air Lines Fends Off United and American To Be Named The ...",
            "url": "http://www.onenewspage.com/n/Press+Releases/74rc55m7i/Delta-Air-Lines-Fends-Off-United-and-American.htm"
        }...
    ]
}

Page Loadtime Historical Returns pageload scores over a period of days (in seconds)
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and brand_id are required parameters. Optional parameter accepts sort order (ASC or DESC), plus unix timestamps for minimum and maximum dates, separated by commas. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Line
Example http://www.magicfirehose.com/api/brand/page_loadtime_historical/30/344?key=<your_api_key>
http://www.magicfirehose.com/api/brand/page_loadtime_historical/all/11.chart?type=line&valueAlias=Page+Load+Time&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Page Load Time Historical",
        "brand_id": 11
    },
    "data": [
        {
            "key": "Page Loadtime",
            "values": [
                [
                    1351407600000,
                    0.29575
                ],
                [
                    1351494000000,
                    0.16994
                ],
                [
                    1351580400000,
                    0.17127
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.4f"
        }
    ]
}

Profile Returns contact, industry category, HQ location information in JSON format
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/brand/profile/all/11?key=<your_api_key>
Response (JSON)
{
  "brand_id": "11",
  "brand_domain": "heardable.com",
  "hscore": "597",
  "active": "1",
  "redirect": "0",
  "cluster": "0",
  "naics_id": "541613",
  "brand_name": "Heardable",
  "brand_owner": "Heardable, Inc.",
  "address": "28545 Old Town Front Street, Ste 206",
  "city": "Temecula",
  "state": "CA",
  "zip": "92590",
  "country": "US",
  "phone": "8885200034",
  "fax": "",
  "email": "marketing@heardable.com",
  "lat": "33.49446",
  "lon": "-117.15011",
  "photo": "11_9361.jpg",
  "added": "1306281600",
  "updated": "1344698897",
  "added_by": "",
  "updated_by": "",
  "verified_by": "0",
  "ref_id": "0",
  "rank": "0",
  "pageload": "0.124",
  "err": "0",
  "type": "0",
  "naics_industry_category": "541613 Marketing Consulting Services"
}

Score Returns data array of daily Heardable Scores and Heardable Subscores for target brand
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Scope (number of days) and brand_id are required parameters. Optional parameters not supported.
Charts Area, Line
Example http://www.magicfirehose.com/api/brand/score/30/1?key=<your_api_key>
http://www.magicfirehose.com/api/brand/score/90/99,57,344.chart?type=line&valueAlias=Heardable+Score&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Heardable Score",
        "brand_id": 1
    },
    "data": [
        {
            "date": 1348133312,
            "date_formatted": "09/20/2012",
            "heardable_score": 687,
            "actionable_score": 75,
            "measurable_score": 100,
            "portable_score": 150,
            "searchable_score": 143,
            "shareable_score": 100,
            "sociable_score": 119
        },
        {
            "date": 1348219712,
            "date_formatted": "09/21/2012",
            "heardable_score": 687,
            "actionable_score": 75,
            "measurable_score": 100,
            "portable_score": 150,
            "searchable_score": 143,
            "shareable_score": 100,
            "sociable_score": 119
        },
        {
            "date": 1348306112,
            "date_formatted": "09/22/2012",
            "heardable_score": 687,
            "actionable_score": 75,
            "measurable_score": 100,
            "portable_score": 150,
            "searchable_score": 143,
            "shareable_score": 100,
            "sociable_score": 119
        }...
    ]
}
Response (d3)

Score (Comparison) Returns data array of daily Heardable Scores and Heardable Subscores for target brand
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Scope (number of days) and brand_id are required parameters. Brnad ID may be in the form of a number of brand ids, separated by commas. Optional parameters not supported.
Charts Line, Cumulative Line
Example http://www.magicfirehose.com/api/brand/score/90/99,57,344?key=<your_api_key>
http://www.magicfirehose.com/api/brand/score/90/99,57,344.chart?type=line&valueAlias=Heardable+Score&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Heardable Score",
        "brand_id": 344
    },
    "data": [
        {
            "key": "Apple",
            "values": [
                [
                    1351487010000,
                    680
                ],
                [
                    1351573410000,
                    680
                ],
                [
                    1351659810000,
                    667
                ]...
            ],
            "color": null,
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Google",
            "values": [
                [
                    1351487010000,
                    626
                ],
                [
                    1351573410000,
                    626
                ],
                [
                    1351659810000,
                    626
                ]...
            ],
            "color": null,
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Facebook",
            "values": [
                [
                    1351487010000,
                    436
                ],
                [
                    1351573410000,
                    485
                ],
                [
                    1351659810000,
                    436
                ]...
            ],
            "color": null,
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

Score (Subscores) Returns data array of Heardable Subscores for target brand
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Scope (number of days) and brand_id are required parameters. Optional parameters not supported.
Charts Area, Stacked Area
Example http://www.magicfirehose.com/api/brand/score/90/99?key=<your_api_key>
http://www.magicfirehose.com/api/brand/score_subscores/90/99.chart?type=area&valueAlias=Heardable+Subscores&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Heardable Subscores",
        "brand_id": 99
    },
    "data": [
        {
            "key": "Sociable",
            "values": [
                [
                    1351402882000,
                    153
                ],
                [
                    1351489282000,
                    153
                ],
                [
                    1351575682000,
                    153
                ],
                [
                    1351662082000,
                    153
                ]
            ],
            "color": null,
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Shareable",
            "values": [
                [
                    1351402882000,
                    70
                ],
                [
                    1351489282000,
                    70
                ],
                [
                    1351575682000,
                    70
                ],
                [
                    1351662082000,
                    70
                ]
            ],
            "color": null,
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Searchable",
            "values": [
                [
                    1351402882000,
                    145
                ],
                [
                    1351489282000,
                    145
                ],
                [
                    1351575682000,
                    145
                ],
                [
                    1351662082000,
                    132
                ]
            ],
            "color": "336699",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Portable",
            "values": [
                [
                    1351402882000,
                    170
                ],
                [
                    1351489282000,
                    170
                ],
                [
                    1351575682000,
                    170
                ],
                [
                    1351662082000,
                    170
                ]
            ],
            "color": "#996600",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Measurable",
            "values": [
                [
                    1351402882000,
                    60
                ],
                [
                    1351489282000,
                    60
                ],
                [
                    1351575682000,
                    60
                ],
                [
                    1351662082000,
                    60
                ]
            ],
            "color": "#cccccc",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Actionable",
            "values": [
                [
                    1351402882000,
                    82
                ],
                [
                    1351489282000,
                    82
                ],
                [
                    1351575682000,
                    82
                ],
                [
                    1351662082000,
                    82
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

Sitemap Returns list of files and directories of target brand site plus visual site map
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameter is brand_domain (must be urlencoded). If API call is designed to support real-time rendering, "scope" (number of results) should NOT be set to "all" for very large sites - pick a number for scope (100 - 500) that will render quickly and create a more readable chart.
Charts Nodelink
Example http://www.magicfirehose.com/api/brand/sitemap/100/11?key=<your_api_key>
http://www.magicfirehose.com/api/brand/sitemap/100/11.chart?value=global_avg&valueAlias=Site+Map&type=nodelink&key=<your_api_key>
Response (JSON)
{
  "brand_id": "11",
  "brand_domain": "heardable.com",
  "name": "Site Map",
  "scope": "all",
  "nodes": [
    {
      "name": "content_ext",
      "nodes": [
        {
          "name": "http:\/\/ajax.googleapis.com\/ajax\/libs\/jquery\/1.7.1\/jquery.min.js",
          "level": "0"
        }
      ]
    },
    {
      "name": "content_int",
      "nodes": null
    },
    {
      "name": "links_ext",
      "nodes": [
        {
          "name": "ww11.1800flowers.com",
          "level": "0"
        },
        {
          "name": "plus.google.com\/116252718580373379797",
          "level": "0"
        },
        {
          "name": "scribd.com\/heardable",
          "level": "0"
        },
        {
          "name": "reddit.com\/domain\/heardable.com",
          "level": "0"
        },
        {
          "name": "slideshare.net\/heardable",
          "level": "0"
        },
        {
          "name": "heardable",
          "level": "0"
        },
        {
          "name": "linkedin.com\/Heardable-inc.",
          "level": "0"
        },
        {
          "name": "digg.com\/heardable",
          "level": "0"
        },
        {
          "name": "flickr.com\/heardable",
          "level": "0"
        },
        {
          "name": "twitter.com\/share",
          "level": "0"
        },
        {
          "name": "vitronics-soltec.com",
          "level": "0"
        },
        {
          "name": "enzoani.com",
          "level": "0"
        },
        {
          "name": "phoenix.edu",
          "level": "0"
        },
        {
          "name": "hds.com",
          "level": "0"
        },
        {
          "name": "bofa.com",
          "level": "0"
        },
        {
          "name": "facebook.com",
          "level": "0"
        },
        {
          "name": "code.jquery.com\/ui\/1.8.21\/jquery-ui.min.js",
          "level": "0"
        },
        {
          "name": "static.getclicky.com\/js",
          "level": "0"
        }
      ]
    },
    {
      "name": "links_int",
      "nodes": [
        {
          "name": "team.php",
          "level": "0"
        },
        {
          "name": "api.php",
          "level": "0"
        },
        {
          "name": "services.php",
          "level": "0"
        },
        {
          "name": "being_heardable.php",
          "level": "0"
        },
        {
          "name": "lists.php",
          "level": "0"
        },
        {
          "name": "login.php",
          "level": "0"
        },
        {
          "name": "about.php",
          "level": "0"
        },
        {
          "name": "home.php",
          "level": "0"
        }
      ]
    }
  ]
}
Response (d3)

Social Handles Returns social handles for 130 social networks, where available
Parameters http://www.magicfirehose.com/api/<method>/<scope>/<brand_id>/<dataset>?key=<your_api_key>
Notes Scope (number of networks), brand_id, network ("all"), and dataset are required parameters. The dataset parameter must be set to "verbose" - "simple" will not return any results.
Example http://magicfirehose.com/api/brand/social_handles/all/11/verbose?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Social Handles",
        "brand_id": 11
    },
    "data": {
        "fb": "Heardable",
        "lj": "heardable",
        "tw": "heardable",
        "ss": "heardable",
        "li": "heardable-inc",
        "gg": "116252718580373379797",
        "po": "goonth",
        "fk": "heardable"
    }
}

Social Networks Returns social data, including handles, for engaged social networks
Parameters http://www.magicfirehose.com/api/<method>/<scope>/<brand_id>/<network>/<max_time_stamp>/<style>?key=<your_api_key>
Notes Scope (number of networks), brand_id, and network ("all" or "fb", "li", "ss", "tw", "yt" to return results for a single network) are required parameters. A unix-format timestamp from the past may be entered as an an additional optional fourth parameter (i.e. 1292112000 ). Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, pie, treemap
Example http://magicfirehose.com/api/brand/social_networks/5/1/all?key=<your_api_key>
http://www.magicfirehose.com/api/brand/social_networks/5/1/all.chart?value=reach&label=title&valueAlias=Reach&type=treemap&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Social Networks",
        "brand_id": 1
    },
    "data": [
        {
            "title": "Facebook",
            "hd_code": "fb",
            "reach": 34.08,
            "date": 1350659206,
            "date_formatted": "19-Oct-2012",
            "likes": 488033,
            "checkins": 242,
            "mentions": 18324,
            "sentiment": 0,
            "handles": [
                "Backcountry"
            ],
            "fill": "#ff6600",
            "color": "#ffffff"
        },
        {
            "title": "Twitter",
            "hd_code": "tw",
            "reach": 28.31,
            "date": 1350659206,
            "date_formatted": "19-Oct-2012",
            "followers": 221,
            "mentions": 0,
            "statuses": 133,
            "sentiment": 0,
            "handles": null,
            "fill": "#ff6600",
            "color": "#ffffff"
        },
        {
            "title": "YouTube",
            "hd_code": "yt",
            "reach": 14.98,
            "date": 1350659206,
            "date_formatted": "19-Oct-2012",
            "subscribers": 0,
            "not used": 0,
            "views": 0,
            "sentiment": 0,
            "handles": null,
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
Response (d3)

Social Fanbase Historical Returns scores over a period of days for a given social network
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and network (i.e. fb, fs, li, ss, tw, yt) are required parameters. Optional parameter accepts sort order (ASC or DESC), plus unix timestamps for minimum and maximum dates, separated by commas. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Area, Line, Stream
Example http://www.magicfirehose.com/api/brand/social_fanbase_historical/90/57,99,56/fb?key=<your_api_key> http://www.magicfirehose.com/api/brand/social_fanbase_historical/90/57,99,56/fb.chart?type=line&valueAlias=Facebook+Likes&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Social Fanbase Historical",
        "brand_id": 56
    },
    "data": [
        {
            "key": "Google",
            "values": [
                [
                    1351407600000,
                    10807307
                ],
                [
                    1351494000000,
                    10812674
                ],
                [
                    1351580400000,
                    10818390
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Apple",
            "values": [
                [
                    1351407600000,
                    6144924
                ],
                [
                    1351494000000,
                    6151135
                ],
                [
                    1351580400000,
                    6157612
                ]
            ],
            "color": "#cccccc",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Microsoft",
            "values": [
                [
                    1351407600000,
                    2021543
                ],
                [
                    1351494000000,
                    2023959
                ],
                [
                    1351580400000,
                    2026219
                ]
            ],
            "color": "#996600",
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

Social Mentions Historical Returns scores over a period of days for a given social network
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and network (i.e. fb, fs, li, ss, tw, yt) are required parameters. Optional parameter accepts sort order (ASC or DESC), plus unix timestamps for minimum and maximum dates, separated by commas. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Area, Line, Stream
Example http://www.magicfirehose.com/api/brand/social_mentions_historical/90/57,99,56/fb?key=<your_api_key> http://www.magicfirehose.com/api/brand/social_mentions_historical/90/57,99,56/fb.chart?type=line&valueAlias=Facebook+Likes&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Social Mentions Historical",
        "brand_id": 56
    },
    "data": [
        {
            "key": "Google",
            "values": [
                [
                    1351407600000,
                    270000
                ],
                [
                    1351494000000,
                    240000
                ],
                [
                    1351580400000,
                    432000
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Apple",
            "values": [
                [
                    1351407600000,
                    216000
                ],
                [
                    1351494000000,
                    240000
                ],
                [
                    1351580400000,
                    270000
                ]
            ],
            "color": "#cccccc",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Microsoft",
            "values": [
                [
                    1351407600000,
                    42353
                ],
                [
                    1351494000000,
                    42353
                ],
                [
                    1351580400000,
                    56842
                ]
            ],
            "color": "#996600",
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

Social Snapshot Historical Returns fanbase and mentions over a period of days for a given brand and social network
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and network (i.e. fb, fs, li, ss, tw, yt) are required parameters. Optional parameter accepts sort order (ASC or DESC), plus unix timestamps for minimum and maximum dates, separated by commas. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Line and Bar
Example http://www.magicfirehose.com/api/brand/social_snapshot_historical/90/57,99,56/fb?key=<your_api_key> http://www.magicfirehose.com/api/brand/social_snapshot_historical/365/790/fb.chart?type=lineplusbar&valueAlias=Likes+vs+Mentions+(JBLU)&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Social Mentions Historical",
        "brand_id": 56
    },
    "data": [
        {
            "key": "Google",
            "values": [
                [
                    1351407600000,
                    270000
                ],
                [
                    1351494000000,
                    240000
                ],
                [
                    1351580400000,
                    432000
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Apple",
            "values": [
                [
                    1351407600000,
                    216000
                ],
                [
                    1351494000000,
                    240000
                ],
                [
                    1351580400000,
                    270000
                ]
            ],
            "color": "#cccccc",
            "xformat": "",
            "yformat": ",.0f"
        },
        {
            "key": "Microsoft",
            "values": [
                [
                    1351407600000,
                    42353
                ],
                [
                    1351494000000,
                    42353
                ],
                [
                    1351580400000,
                    56842
                ]
            ],
            "color": "#996600",
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

Stats Returns current statistics for system
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>?key=<your_api_key>
Notes Scope ("all") is required.
Example http://www.magicfirehose.com/api/brand/stats/all?key=<your_api_key>
Response (JSON)
{
    "listings": "14939829",
    "listings_text": "14.9 million",
    "industry_categories": 1188,
    "geographic_zones": 41999,
    "social_networks": 130,
    "vars": 682
}

Traffic Data Historical Returns traffic data from Alexa and other sources over a given period of days
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of days), and brand_id are required parameters. Type="arank" or Alexa Rank by default. Other possible values include "apvpu" (avg_pages_viewed_per_user), "dpva" (daily_page_views_adj), "drpm" (daily_reach_per_million), "lic" (links_in_count), "pvpm" (page_views_per_million). Optional parameter accepts sort order (ASC or DESC), plus unix timestamps for minimum and maximum dates, separated by commas. If no timestamps are provided, latest results will be returned, based on the scope.
Charts Line
Example http://www.magicfirehose.com/api/brand/traffic_data_historical/30/1?key=<your_api_key>
http://www.magicfirehose.com/api/brand/traffic_data_historical/30/1.chart?value=daily_page_views_adj&valueAlias=Daily%20Page%20Views&type=line&key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Traffic Data (Alexa Rank)",
        "brand_id": 56
    },
    "data": [
        {
            "key": "Microsoft",
            "values": [
                [
                    1351494000000,
                    21
                ],
                [
                    1351580400000,
                    21
                ],
                [
                    1351666800000,
                    21
                ]
            ],
            "color": "#ff6600",
            "xformat": "",
            "yformat": ",.0f"
        }
    ]
}
Response (d3)

URLs Returns blog, mobile, and website URLs for target brand, if available
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>?key=<your_api_key>
Notes Method and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/brand/urls/all/11?key=<your_api_key>
Response (JSON)
{
  "blog": "http:\/\/www.backcountry.com\/store\/all\/GearReviews.html",
  "mobile": null,
  "web": "http:\/\/backcountry.com"
}

Vendors - Advertising List of advertising and affiliate network vendors utilized by target brand (highlighted) vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<scores_id>/<max_unix_time>/<style>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_advertising/10/11?key=<your_api_key>
http://www.magicfirehose.com/api/brand/vendors_advertising/10/11/0/0/#ff6600,#cccccc,#ffffff,#ffffff.chart?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Advertising",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "DoubleClick",
            "brand_status": 1,
            "global_avg": 24.83396,
            "global_avg_formatted": "24.83%",
            "fill": "#ff6600",
            "color": "#ffffff"
        },
        {
            "title": "Google Ad Services",
            "brand_status": 0,
            "global_avg": 9.44268,
            "global_avg_formatted": "9.44%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "DART",
            "brand_status": 0,
            "global_avg": 7.94109,
            "global_avg_formatted": "7.94%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
}
Response (d3)

Vendors - Doc Sharing List of document sharing abd storage vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_document_sharing/10/11?key=<your_api_key>
http://www.magicfirehose.com/api/brand/vendors_document_sharing/10/11/0/0/#ff6600,#cccccc,#ffffff,#ffffff.chart?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Document Sharing",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "SlideShare ",
            "brand_status": 0,
            "global_avg": 1.09731,
            "global_avg_formatted": "1.10%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Scribd",
            "brand_status": 0,
            "global_avg": 0.14438,
            "global_avg_formatted": "0.14%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "myPlick",
            "brand_status": 0,
            "global_avg": 0,
            "global_avg_formatted": "0.00%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Live Chat List of live chat technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_live_chat/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Live Chat",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "LivePerson",
            "brand_status": 0,
            "global_avg": "1.47271",
            "global_avg_formatted": "1.47%"
        },
        {
            "title": "Meebo",
            "brand_status": 0,
            "global_avg": "1.06844",
            "global_avg_formatted": "1.07%"
        },
        {
            "title": "Boldchat",
            "brand_status": 0,
            "global_avg": "0.31764",
            "global_avg_formatted": "0.32%"
        }...
     ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Mobile Advertising List of mobile advertising technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_mobile_advertising/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Mobile",
        "brand_id": "529"
    },
    "data": [
        {
		"title": "Quantcast Mobile",
		"brand_status": 0,
		"global_avg": "6.66458",
		"global_avg_formatted": "6.66%"
        },
        {
		"title": "Gravatar",
		"brand_status": 0,
		"global_avg": "1.47059",
		"global_avg_formatted": "1.47%"
        },
        {
		"title": "PercentMobile",
		"brand_status": 0,
		"global_avg": "0.09387",
		"global_avg_formatted": "0.09%"
        }...
     ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Trust Seals List of reputation technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_trust_seals/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Trust Seals",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "Adwords Qualified Company",
            "brand_status": 0,
            "global_avg": 7.73895,
            "global_avg_formatted": "7.74%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Website Optimizer Authorized Consultant",
            "brand_status": 0,
            "global_avg": 7.73895,
            "global_avg_formatted": "7.74%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Better Business Bureau",
            "brand_status": 0,
            "global_avg": 3.66734,
            "global_avg_formatted": "3.67%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Video List of embedded video technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_video/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Video",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "Adobe (Flash)",
            "brand_status": 1,
            "global_avg": 55.18337,
            "global_avg_formatted": "55.18%",
            "fill": "#ff6600",
            "color": "#ffffff"
        },
        {
            "title": "Brightcove",
            "brand_status": 0,
            "global_avg": 3.95611,
            "global_avg_formatted": "3.96%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Codecs Generic",
            "brand_status": 0,
            "global_avg": 3.89835,
            "global_avg_formatted": "3.90%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
    
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Web Analytics List of web analytics technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_web_analytics/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Web Analytics",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "Google Analytics",
            "brand_status": 0,
            "global_avg": 63.18221,
            "global_avg_formatted": "63.18%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Adobe SiteCatalyst",
            "brand_status": 0,
            "global_avg": 20.58908,
            "global_avg_formatted": "20.59%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "PowerPhlogger",
            "brand_status": 0,
            "global_avg": 13.31216,
            "global_avg_formatted": "13.31%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Web Optimization List of web optimization technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_web_optimization/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Web Optimization",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "Facebook Like",
            "brand_status": 0,
            "global_avg": 47.47329,
            "global_avg_formatted": "47.47%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Google +1",
            "brand_status": 0,
            "global_avg": 17.44152,
            "global_avg_formatted": "17.44%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Google Website Opt...",
            "brand_status": 0,
            "global_avg": 7.85446,
            "global_avg_formatted": "7.85%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Vendors - Web Services List of web service and API technology vendors utilized by target brand vs. all brands
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Scores ID or max_unix_time enable results from a previous scan date to be displayed. Style (optional) may contain four hex colors separated by commas, in the following configuration ('active_bg_color, active_font_color, inactive_bg_color, inactive_font_color').
Charts Bar, Pie, Treemap
Example http://www.magicfirehose.com/api/brand/vendors_web_services/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Vendors > Web Services",
        "brand_id": "346"
    },
    "data": [
        {
            "title": "jQuery",
            "brand_status": 0,
            "global_avg": 19.279333447861,
            "global_avg_formatted": "19.28%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Google APIs",
            "brand_status": 0,
            "global_avg": 12.656760006872,
            "global_avg_formatted": "12.66%",
            "fill": "#cccccc",
            "color": "#ffffff"
        },
        {
            "title": "Facebook APIs",
            "brand_status": 0,
            "global_avg": 6.91032468648,
            "global_avg_formatted": "6.91%",
            "fill": "#cccccc",
            "color": "#ffffff"
        }...
    ]
}
Response (d3)
See "Vendors > Advertising" for example (treemap)

Chart

Competitors Returns interactive d3 pie, bar or line chart. Optional tool bar allows charts to be modified, including choice of labels, data rollups, and different views - without refresh.
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_id>/<network>/<options>.chart?key=<your_api_key>
Notes Requires scope (number of results), brand_id. Optional network parameter denotes heardable ("hd") or a target social network (i.e. "fb", "tw", "yt".) Options parameter may be blank or can contain two integers separated by commas: "1,0" returns industry competitors; "0,1" returns local/geographic competitors; "1,1" returns competitors in your industry and location. "0,0" returns non-filtered leaderboard (i.e. "Top 100).
Example http://www.magicfirehose.com/api/brand/competitors/10/11/tw/0,0,1.chart?value=score&label=brand_name&type=bar&key=<your_api_key>
Response (JSON)

CSV Returns interactive d3 pie, bar or line chart based on user-supplied data file (in comma separated values (CSV) format). Optional tool bar allows charts to be modified, including choice of labels based on table headers.
Parameters http://www.magicfirehose.com/api/brand/<method>/<scope>/<brand_domain>/<options>?key=<your_api_key>
Notes Requires scope (number of results), filename (may be url - if url, should be encoded).
Example http://magicfirehose.com/api/csv.chart?scope=10&filename=data.csv&value=Population (mill)&label=Name&type=pie&key=<your_api_key>
Response (JSON)

Import Import data in CSV format for use in chart.
Parameters http://www.magicfirehose.com/api/import?key=<your_api_key>
Notes Selected files are uploaded to a user directory, and data is displayed in JSON format. If optional help parameter is set to true, you may select from all combinations of legends, data inputs, or chart types (i.e pie, line, bar.)
Example http://www.magicfirehose.com/api/import?help=true&key=<your_api_key>
Response (JSON)
[
    {
        "Name": "Canada",
        "Population (mill)": 33.9,
        "Average Life Expectancy": 80.7,
        "Area (1000 sq mi)": 3854.085,
        "Continent": "America"
    },
    {
        "Name": "US",
        "Population (mill)": 308.3,
        "Average Life Expectancy": 78.2,
        "Area (1000 sq mi)": 3784.191,
        "Continent": "America"
    },
    {
        "Name": "Germany",
        "Population (mill)": 82.3,
        "Average Life Expectancy": 79.4,
        "Area (1000 sq mi)": 137.847,
        "Continent": "Europe"
    }...
]

Ext

http://www.magicfirehose.com/api/ext/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>

Provides convenient, real-time access to a range of third-party APIs via a single interface.

Parameter Type Required Permitted Values
method string yes "alexa", "digg", "ebay", "eventful", "facebook", "flickr", "foursquare", "getsatisfaction", "google", "ipinfodb", "linkedin", "myspace", "reddit", "scribd", "slideshare", "stumbleupon", "tumblr", "twitter", "vimeo", "wikipedia", "yahoo", "yelp", "youtube"
scope string yes
Alexa: "all", "links_in"
Digg: "all" (deprecated by Digg)
eBay: "all"
EDGAR: "all" (see Finance calls)
Eventful: "all", "events", "venues"
Facebook: "all"
Flickr: "all"
Foursquare: "all"
GetSatisfaction: "all", "companies", "people", "products", "topics"
Google: "all", "places_add", "places_delete", "places_search_advanced", "places_search_text", "spellcheck"
IPInfoDB: "all"
LinkedIn: "all", "company", "products"
MySpace: "all"
Pinterest: "all" (awaiting official release)
Reddit: "all"
Scribd: "all"
SlideShare: "all"
StumbleUpon: "all"
Tumblr: "all"
Twitter: "all", "influencers", "statuses"
Vimeo: "all"
Whois: "all"
Wikipedia: "all"
Yahoo: "all", "geoplanet", "inbound_links", "indexed_pages", "placefinder"
Yelp: "all"
YouTube: "all"
brand_id integer yes Heardable brand_id
options comma-separated strings no
Alexa: "unix_date_start, unix_date_end"
Google: "search_term_1, search_term_2, search_term_3..."
IPInfoDB: "123.345.678.98"

Example http://magicfirehose.com/api/ext/linkedin/company/99/noopt?key=<your_api_key>
{
"brand_id": "99",
"source": "linkedin",
"handle": "apple",
"data": {
  "blogRssUrl": "http:\/\/images.apple.com\/main\/rss\/hotnews\/hotnews.rss",
  "description": "Apple designs Macs, the best personal computers in the world, along with Mac OS X...",
  "id": 162479,
  "locations": {
    "_total": 1,
    "values": [
      {
	"address": {
	  "city": "Cupertino",
	  "postalCode": "95014",
	  "street1": "1 Infinite Loop"
	},
	"isHeadquarters": true
      }
    ]
  },
  "logoUrl": "http:\/\/m3.licdn.com\/mpr\/mpr\/p\/2\/000\/082\/2e6\/39570d2.png",
  "name": "Apple",
  "numFollowers": 335745,
  "ticker": "AAPL",
  "websiteUrl": "http:\/\/www.apple.com\/"
},
"followers": 335745,
"verified": 1
}

Reports

Author Returns author name for a given Report ID.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. User_id may be included as an optional parameter if report_id not known.
Example http://www.magicfirehose.com/api/reports/author/all/5294033?key=<your_api_key>
Response (JSON)
"John Sharp"

Create Creates new report with unique report ID, based on an initial brand adn author (user) id.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<brand_id>/<user_id>/<options>?key=<your_api_key>
Notes Scope ("all") and brand_id (new reports must include at least one brand) are required parameters. Title may be included as an optional parameter if urlencoded. Author (user) id is derived from your API key.
Example http://www.magicfirehose.com/api/reports/create/all/8/Most+Active+Brands+In+North+America?key=<your_api_key>
Response (JSON)
{
    "report_id": "70193422",
    "brand_id": 8,
    "author_id": "2",
    "report_title": "Most Active Brands In North America",
    "added": "1347693799"
}

Data Returns all data for a given report_id, including featured brands
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/data/all/5294033?key=<your_api_key>
Response (JSON)
{
  "meta": {
        "title": "Report Data",
        "report_id": 5294033,
	"report_title": "Top 20 US Airlines in Social Media",
        "publisher_id": 2,
        "storefront": "heardable-reports"
    },  
  "data": [
    {
      "id": "1",
      "report_id": "5294033",
      "brand_id": "790",
      "user_id": "2",
      "sponsor": "0",
      "hero": "790",
      "freq": "1",
      "added": "1319718957",
      "active": "1",
      "make_public": "0",
      "scantime": "55",
      "updated": "1339039903",
      "date_published": "0"
    },
    {
      "id": "2",
      "report_id": "5294033",
      "brand_id": "537",
      "user_id": "2",
      "sponsor": "0",
      "hero": "790",
      "freq": "1",
      "added": "1319718957",
      "active": "1",
      "make_public": "0",
      "scantime": "43",
      "updated": "1339039726",
      "date_published": "0"
    },
    {
      "id": "3",
      "report_id": "5294033",
      "brand_id": "539",
      "user_id": "2",
      "sponsor": "0",
      "hero": "790",
      "freq": "1",
      "added": "1319718957",
      "active": "1",
      "make_public": "0",
      "scantime": "56",
      "updated": "1339039788",
      "date_published": "0"
    }
  ]
}

Deactivate Suspends report, delists report where publicly viewable; included brands are not affected.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/deactivate/1/594030?key=<your_api_key>
Response (JSON)
true

Delete Deletes report from the database; included brands are not affected.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/delete/1/594030?key=<your_api_key>
Response (JSON)
true

Publish Creates a publishing date associated with an unpublished report. To change to date and refresh the data contained in a report, use the Update PubDate method.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope (1) and report_id are required parameters. Options parameter should contain three elements: month, day, year (i.e. 05,12,2012) separated by commas.
Example http://www.magicfirehose.com/api/reports/publish/1/594030/05,12,2012?key=<your_api_key>
Response (JSON)
true

Reactivate Reactivates suspended report, report becomes publicly viewable again.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/reactivate/1/594030?key=<your_api_key>
Response (JSON)
true

Refresh Adds brands to scan queue so Heardable Engine can refresh data. Refresh scans usually begin running within one minute, and generally take around 60 seconds per brand to complete.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/refresh/all/594030?key=<your_api_key>
Response (JSON)
true

Reports Featuring Brand Returns social handles for top 100 social networks, where available
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/reports_featuring_brand/all/11?key=<your_api_key>
Response (JSON)
[
  {
    "id": "46",
    "report_id": "6553847",
    "brand_id": "11",
    "user_id": "2",
    "sponsor": "0",
    "hero": "11",
    "report_title": "Using Data to Drive Brand Optimization",
    "freq": "1",
    "added": "1319957355",
    "active": "1",
    "make_public": "0",
    "scantime": "19",
    "updated": "1327241026",
    "date_published": "0"
  },
  {
    "id": "346",
    "report_id": "8141037",
    "brand_id": "11",
    "user_id": "2",
    "sponsor": "0",
    "hero": "1",
    "report_title": "SEO Analysis - The Next Wave",
    "freq": "1",
    "added": "1325146693",
    "active": "0",
    "make_public": "0",
    "scantime": "19",
    "updated": "1327240801",
    "date_published": "0"
  },
  {
    "id": "219733",
    "report_id": "4620295",
    "brand_id": "11",
    "user_id": "7",
    "sponsor": "0",
    "hero": "99",
    "report_title": "The Top 10 Digital Marketing Teams",
    "freq": "1",
    "added": "1345679030",
    "active": "1",
    "make_public": "0",
    "scantime": "0",
    "updated": "1345679030",
    "date_published": "0"
  }...
]

Scores Shows current Heardable Scores and Subscore information for all brands.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope ("all") and report_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/reports/show_scores/all/594030?key=<your_api_key>
Response (JSON)
[
    {
        "brand_id": "15284204",
        "brand_score": 611,
        "portable": "160",
        "shareable": "60",
        "measurable": "85",
        "actionable": "84",
        "sociable": "123",
        "searchable": "99",
        "brand_score_balance": 389,
        "points_behind_leader": 0,
        "percentage_behind_leader": null,
        "brand_score_cat": null,
        "growth": "0.00",
        "brand_domain": "rapha.cc",
        "brand_name": "Rapha",
        "brand_city": "London",
        "brand_state": "",
        "brand_zip": "NW5 3ED",
        "brand_country": "UK",
        "latitude": "51.54731",
        "longitude": "-0.14632"
    },
    {
        "brand_id": "15642069",
        "brand_score": 571,
        "portable": "150",
        "shareable": "100",
        "measurable": "85",
        "actionable": "50",
        "sociable": "105",
        "searchable": "81",
        "brand_score_balance": 429,
        "points_behind_leader": 40,
        "percentage_behind_leader": "6.55",
        "brand_score_cat": null,
        "growth": "0.00",
        "brand_domain": "castelli-cycling.com",
        "brand_name": "Castelli",
        "brand_city": "Fonzaso",
        "brand_state": "",
        "brand_zip": "32030",
        "brand_country": "IT",
        "latitude": "46.0060496",
        "longitude": "11.8038066"
    },
    {
        "brand_id": "15642067",
        "brand_score": 426,
        "portable": "10",
        "shareable": "70",
        "measurable": "85",
        "actionable": "26",
        "sociable": "116",
        "searchable": "119",
        "brand_score_balance": 574,
        "points_behind_leader": 185,
        "percentage_behind_leader": "30.28",
        "brand_score_cat": null,
        "growth": "0.00",
        "brand_domain": "campagnolo.com",
        "brand_name": "Campagnolo",
        "brand_city": "Vicenza",
        "brand_state": "",
        "brand_zip": "36100",
        "brand_country": "IT",
        "latitude": "45.5194801",
        "longitude": "11.5062984"
    }...
]

Update PubDate Updates publishing date associated with an existing report.
Parameters http://www.magicfirehose.com/api/reports/<method>/<scope>/<report_id>/<options>?key=<your_api_key>
Notes Scope (1) and report_id are required parameters. Options parameter should contain three elements: month, day, year (i.e. 05,12,2012) separated by commas.
Example http://www.magicfirehose.com/api/reports/update_pubdate/1/594030/05,12,2012?key=<your_api_key>
Response (JSON)
true

Site Audit

Alt Tags Returns percentage of total alt tag usage for recent scans up to $rpp limit
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters include scores_id, in the form of a known integer/scores_id from a recent scan.
Example http://www.magicfirehose.com/api/site/alt_tags/1000/11?key=<your_api_key>
Response (JSON)
{
  "brand_id": "11",
  "scores_id": "0",
  "brand_avg": "43",
  "global_avg": 53.57
  "global_avg_formatted": "53.57%"
}

Contact Methods Returns number and type of contact methods, and global utlization rate
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters include scores_id, in the form of a known integer/scores_id from a recent scan.
Example http://www.magicfirehose.com/api/site/contact_methods/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Contact Methods",
        "brand_id": 47,
        "brand_name": "Firetide"
    },
    "data": [
        {
            "title": "Contact link",
            "score": 100,
            "fill": "#ff6600",
            "color": "#ffffff",
            "global_avg": 76.94565,
            "global_avg_formatted": "76.95%"
        },
        {
            "title": "Phone number",
            "score": 100,
            "fill": "#ff6600",
            "color": "#ffffff",
            "global_avg": 59.26526,
            "global_avg_formatted": "59.27%"
        },
        {
            "title": "Privacy policy",
            "score": 100,
            "fill": "#cccccc",
            "color": "#555555",
            "global_avg": 54.81227,
            "global_avg_formatted": "54.81%"
        }...
    ]
}

Customer Focus Subjective analysis: Analyzes page for customer-centric vs. brand-centric words
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters include scores_id, in the form of a known integer/scores_id from a recent scan. Scores above 50% represent a positive (customer-focused) result.
Charts Pie, Minipie
Example http://www.magicfirehose.com/api/site/customer_focus/100/11?key=<your_api_key>
http://www.magicfirehose.com/api/site/customer_focus/100/11.chart?label=title&headline=false&type=minipie&key=<your_api_key>
Response (JSON)
{
  "brand_id": "11",
  "scores_id": "",
  "brand_avg": "50",
  "global_avg": 33.36,
  "global_avg_formatted": "33.36%"
}

Links on Home Page List of links from target brand home page
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters allow a domain to be used (i.e. 'heardable.com') in combination with brand_id=0.
Example http://www.magicfirehose.com/api/site/links_home_page/100/11?key=<your_api_key>
http://www.magicfirehose.com/api/site/links_home_page/100/0/heardable.com?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Links Home Page",
        "brand_id": "65",
        "brand_name": "Amazon.com"
    },
    "data": [
        {
            "link": "/kindle-store-ebooks-newspapers-blogs/b/ref=sa_menu_kstore3/175-1174798-8539620/",
            "host": "amazon.com"
        },
        {
            "link": "/kindle-store-ebooks-newspapers-blogs/b/ref=sa_menu_kstore3/175-1836125-4171460/",
            "host": "amazon.com"
        },
        {
            "link": "/kindle-store-ebooks-newspapers-blogs/b/ref=sa_menu_kstore3/175-3242324-4042658/",
            "host": "amazon.com"
        }...
    ]
}

Links Inbound List of links inbound to target brand website
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters allow a domain to be used (i.e. 'heardable.com') in combination with brand_id=0.
Example http://www.magicfirehose.com/api/site/links_inbound/10/0/google.com?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Links In",
        "brand_id": "57",
        "brand_name": "Google"
    },
    "data": [
        {
            "link": "google.com/finance",
            "host": "joystiq.com"
        },
        {
            "link": "google.com/url",
            "host": "sun-sentinel.com"
        },
        {
            "link": "google.com/wallet/",
            "host": "slashdot.org"
        }...
    ]
}

Links Outbound List of links outbound from target brand website
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters allow a domain to be used (i.e. 'heardable.com') in combination with brand_id=0.
Example http://www.magicfirehose.com/api/site/links_outbound/10/0/google.com?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Links Out",
        "brand_id": "11",
        "brand_name": "Heardable"
    },
    "data": [
        {
            "link": "//ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js",
            "host": "googleapis.com"
        },
        {
            "link": "//ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js",
            "host": "googleapis.com"
        },
        {
            "link": "//cdn.jquerytools.org/1.2.4/jquery.tools.min.js",
            "host": "jquerytools.org"
        }...
    ]
}

Meta Tag Info Meta tag and keyword (meta and visible) information from target brand website
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope ("stored", "live"), and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/site/meta_tags/all/11?key=<your_api_key>
Response (JSON)
{
  "brand_id": "11",
  "brand_domain": "heardable.com",
  "title": "Heardable Real-Time Contextual Brand Analytics",
  "author": "marketing@heardable.com",
  "description": "Heardable is the world's only real-time contextual brand analytics platform. We make brand monitoring easy - helping organizations make smarter, faster business decisions in a way that impacts tomorrow's quarterly results.",
  "language": "en-us",
  "robots": "all",
  "keywords": "heardable, brand, analytics, real-time data, big data, branding, brand health score, Heardable Score, social media monitoring, Gunther Sonnenfeld, Jon Samsel, John Sharp",
  "keywords_formatted": {
    "cloud_status": 1,
    "keywords_total_visible": 0,
    "keywords_total_meta": 31,
    "keyword_cloud_visible": "",
    "keyword_cloud_meta": "Unavailable",
    "hero_chart": "keyword_cloud_meta"
  }
}

Page Elements Status of page elements most commonly used to compile SEO rankings
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope (number of results), and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/site/page_elements/10/11?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Page Elements",
        "brand_id": "66",
        "brand_name": "PDX Mindshare"
    },
    "data": [
        {
            "title": "Site map",
            "brand_status": 0,
            "global_avg": "31.73768",
            "global_avg_formatted": "31.74%"
        },
        {
            "title": "Robots-DMOZ",
            "brand_status": 0,
            "global_avg": "6.85153",
            "global_avg_formatted": "6.85%"
        },
        {
            "title": "H3 tags",
            "brand_status": 0,
            "global_avg": "0.08096",
            "global_avg_formatted": "0.08%"
        }...
    ]
}

Page Load Time Time (in seconds) required to connect to remote server, load page elements
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope ("all"), and brand_id are required parameters. Optional parameters are not supported.
Example http://www.magicfirehose.com/api/site/page_loadtime/all/11?key=<your_api_key>
Response (JSON)
[
  {
    "brand_id": "11",
    "loadtime": "0.32589"
  }
]

Server Configuration Displays which url is primary (200) url, and if secondary redirect is correctly configured (301)
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope ("all"), and brand_id are required parameters. Brand domain (i.e. heardable.com) may be entered as an optional parameter.
Example http://www.magicfirehose.com/api/site/server_config/all/11?key=<your_api_key>
http://www.magicfirehose.com/api/site/server_config/all/0/heardable.com?key=<your_api_key>
Response (JSON)
{
    "meta": {
        "title": "Server Configuration",
        "brand_id": "45",
        "brand_name": "CreditCards.com"
    },
    "data": [
        {
            "url": "http://creditcards.com",
            "code": 200
        },
        {
            "url": "http://www.creditcards.com",
            "code": 200
        }
    ]
}

Site Stats Displays inbound, indexed links, etc.
Parameters http://www.magicfirehose.com/api/site/<method>/<scope>/<brand_id>/<options>?key=<your_api_key>
Notes Method, scope ("all"), and brand_id are required parameters. No optional parameters supported.
Example http://www.magicfirehose.com/api/site/site_stats/all/11?key=<your_api_key>
Response (JSON)
{
    "brand_id": "11",
    "inbound_links": "382",
    "indexed_pages": "21"
}