Introduction

Authentication & Access

API Errors

Validation Error Response
{
  "errors": {
    "url": [
      "Invalid URL format"
    ]
  },
  "type": "https://app.brandvantage.co/api-problem/validation-error",
  "title": "Validation Error",
  "status": 400,
  "traceId": "0HM9NIJTKU99A:00000002"
}
Processing Error Response
{
  "type": "https://app.brandvantage.co/api-problem/processing-error",
  "title": "Processing Error",
  "detail": "Unable to resolve hostname for remote server",
  "status": 500,
  "traceId": "0HM9NIJTKU99C:00000002"
}

Web Page API

Request
  • curl https://app.brandvantage.co/api/data-source/web-page \
    -d apiKey=YOUR_API_KEY \
    -d url=TARGET_URL \
    -G
Response
{
  "@type": "WebPage",
  "@context": "https://schema.org",
  "name": "Web Page Name",
  "alternateName": "Website Name",
  "image": {
    "@context": "https://schema.org",
    "@type": "ImageObject",
    "url": "https://example.org/path/to/the-image.jpg"
  },
  "description": "This is an example description for a web page",
  "text": "This is the main content of the page",
  "mainContentOfPage": {
    "@context": "https://schema.org",
    "@type": "WebPageElement",
    "cssSelector": "#main>div>div:nth-child(2)"
  }
}

News Article Search API

Request
  • curl https://app.brandvantage.co/api/data-source/news-article/search \
    -d apiKey=YOUR_API_KEY \
    -d query=QUERY \
    -G
Response
{
  "totalResults": 7,
  "items": [
    {
      "@type": "NewsArticle",
      "@context": "https://schema.org",
      "name": "Article Name",
      "url": "https://example.org/posts/article-url",
      "datePublished": "2020-07-12T06:00",
      "description": "This is an example description of an article",
      "text": "This is the example content of an article",
      "inLanguage": [
        "en-AU"
      ],
      "image": {
        "@context": "https://schema.org",
        "@type": "ImageObject",
        "url": "https://example.org/path/to/the-image.jpg"
      },
      "author": {
        "name": "Author's name"
      },
      "publisher": {
        "identifier": "public-feed-identifier"
      }
    }
  ]
}

News Article Sources API

Request
  • curl https://app.brandvantage.co/api/data-source/news-article/sources \
    -d apiKey=YOUR_API_KEY \
    -G
Response
{
  "totalResults": 4,
  "items": [
    {
      "@type": "Organization",
      "@context": "https://schema.org",
      "name": "Organization Name",
      "identifier": "organization-public-feed-identifier",
      "url": "https://example.org/",
      "knowsLanguage": [
        "en",
        "en-US"
      ],
      "location": {
        "@type": "Country",
        "identifier": "US"
      }
    }
  ]
}