GET /api/v2/search
Search for searchable insights, entities and insight providers

Examples

GET /api/v2/search?query-text=Rocha&search-type=quick
200
{
  "data": [
    {
      "id": "700",
      "type": "accounts",
      "links": {
        "self": "http://test.host/api/v2/accounts/700"
      },
      "attributes": {
        "slug": "zach-rocha",
        "name": "Zach Rocha",
        "company-name": null,
        "avatar-url": {
          "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/700/small/test.png?1503974924",
          "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/700/medium/test.png?1503974924",
          "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/700/large/test.png?1503974924",
          "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/700/xlarge/test.png?1503974924"
        },
        "country": null,
        "title": "CEO",
        "is-insight-provider": true,
        "is-client": false,
        "is-synthetic": false,
        "short-name": "Jerry"
      },
      "relationships": {
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/accounts/700/relationships/content-verticals",
            "related": "http://test.host/api/v2/accounts/700/content-verticals"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/accounts/700/relationships/countries",
            "related": "http://test.host/api/v2/accounts/700/countries"
          }
        },
        "sectors": {
          "links": {
            "self": "http://test.host/api/v2/accounts/700/relationships/sectors",
            "related": "http://test.host/api/v2/accounts/700/sectors"
          }
        }
      }
    },
    {
      "id": "260",
      "type": "insights",
      "links": {
        "self": "http://test.host/api/v2/insights/260"
      },
      "attributes": {
        "slug": "commodi-expedita-autem-quam-qui",
        "tagline": "Commodi Expedita Autem Quam Qui",
        "imperative": "bullish",
        "executive-summary": "Utilities have been out of favor since the beginning of the current bull market several years ago, but utilities are good values and deserve a place in balanced portfolios. Consolidated Edison had a weak 2013 financially due to Hurricane Sandy, but it is recovering nicely and sports an attractive yield. American Electric Power has been a steady performer and stands to benefit down the road from continuing development of shale oil.  Consolidated Edison had a weak 2013 financially due to Hurricane Sandy, but it is recovering nicely and sports an attractive yield.",
        "countries": [
          "Singapore"
        ],
        "published-at": "2017-08-29T10:53:44.683+08:00",
        "total-account-read": 0,
        "total-combined-read": 0,
        "total-public-read": 0
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://test.host/api/v2/insights/260/relationships/account",
            "related": "http://test.host/api/v2/insights/260/account"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/insights/260/relationships/content-verticals",
            "related": "http://test.host/api/v2/insights/260/content-verticals"
          }
        },
        "primary-entity": {
          "links": {
            "self": "http://test.host/api/v2/insights/260/relationships/primary-entity",
            "related": "http://test.host/api/v2/insights/260/primary-entity"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "total-count": 2,
    "record-count": 0
  },
  "links": {
    "first": "http://test.host/api/v2/searches?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/searches?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

Params

Param name Description
query-text
optional

URL query to search related items

Validations:

  • Must be a String