Authentication is required.


GET /api/v2/insights
List Insights

Examples

GET /api/v2/insights
200
{
  "data": [
    {
      "id": "77",
      "type": "insights",
      "links": {
        "self": "http://test.host/api/v2/insights/77"
      },
      "attributes": {
        "countries": [
          "Singapore"
        ],
        "imperative": "bullish",
        "slug": "suscipit-nam-dolorum-autem-reprehenderit",
        "published-at": "2017-08-29T08:45:02.157+08:00",
        "aasm-state": "published",
        "format-type": "in-depth",
        "show-author-names": true,
        "tagline": "Suscipit Nam Dolorum Autem Reprehenderit",
        "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.",
        "gics": {
          "sectors": [
            "Energy"
          ],
          "industry-groups": [],
          "industries": []
        },
        "total-account-read": 0,
        "total-public-read": 0,
        "total-combined-read": 0,
        "annotations-count": 0,
        "comments-count": 0,
        "total-discussions": 0,
        "published-forked-count": 0,
        "updated-at": "2017-08-29T10:45:02.571+08:00",
        "aasm-state-updated-at": null,
        "is-sk-content": true,
        "linkback": null,
        "likes-count": 0,
        "dislikes-count": 0,
        "no-sector": false,
        "is-read": false,
        "my-like-score": 0,
        "restriction-reason": null,
        "introduced-total-views": 0
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/account",
            "related": "http://test.host/api/v2/insights/77/account"
          }
        },
        "images": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/images",
            "related": "http://test.host/api/v2/insights/77/images"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/content-verticals",
            "related": "http://test.host/api/v2/insights/77/content-verticals"
          }
        },
        "primary-entity": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/primary-entity",
            "related": "http://test.host/api/v2/insights/77/primary-entity"
          }
        },
        "secondary-entities": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/secondary-entities",
            "related": "http://test.host/api/v2/insights/77/secondary-entities"
          }
        },
        "activities": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/activities",
            "related": "http://test.host/api/v2/insights/77/activities"
          }
        },
        "upstream-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/upstream-insights",
            "related": "http://test.host/api/v2/insights/77/upstream-insights"
          }
        },
        "downstream-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/downstream-insights",
            "related": "http://test.host/api/v2/insights/77/downstream-insights"
          }
        },
        "main-insight-document": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/main-insight-document",
            "related": "http://test.host/api/v2/insights/77/main-insight-document"
          }
        },
        "insight-documents": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/insight-documents",
            "related": "http://test.host/api/v2/insights/77/insight-documents"
          }
        },
        "insight-disclosures": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/insight-disclosures",
            "related": "http://test.host/api/v2/insights/77/insight-disclosures"
          }
        },
        "comment-threads": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/comment-threads",
            "related": "http://test.host/api/v2/insights/77/comment-threads"
          }
        },
        "originated-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/originated-insights",
            "related": "http://test.host/api/v2/insights/77/originated-insights"
          }
        },
        "comments": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/comments",
            "related": "http://test.host/api/v2/insights/77/comments"
          }
        },
        "suggested-forkable-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/suggested-forkable-insights",
            "related": "http://test.host/api/v2/insights/77/suggested-forkable-insights"
          }
        },
        "citations": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/citations",
            "related": "http://test.host/api/v2/insights/77/citations"
          }
        },
        "annotations": {
          "links": {
            "self": "http://test.host/api/v2/insights/77/relationships/annotations",
            "related": "http://test.host/api/v2/insights/77/annotations"
          }
        }
      }
    },
    {
      "id": "78",
      "type": "insights",
      "links": {
        "self": "http://test.host/api/v2/insights/78"
      },
      "attributes": {
        "countries": [
          "Singapore"
        ],
        "imperative": "bullish",
        "slug": "eum-earum-nam-laudantium-rem",
        "published-at": "2017-08-29T08:45:03.313+08:00",
        "aasm-state": "published",
        "format-type": "in-depth",
        "show-author-names": true,
        "tagline": "Eum Earum Nam Laudantium Rem",
        "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.",
        "gics": {
          "sectors": [
            "Energy"
          ],
          "industry-groups": [],
          "industries": []
        },
        "total-account-read": 0,
        "total-public-read": 0,
        "total-combined-read": 0,
        "annotations-count": 0,
        "comments-count": 0,
        "total-discussions": 0,
        "published-forked-count": 0,
        "updated-at": "2017-08-29T10:45:03.681+08:00",
        "aasm-state-updated-at": null,
        "is-sk-content": true,
        "linkback": null,
        "likes-count": 0,
        "dislikes-count": 0,
        "no-sector": false,
        "is-read": false,
        "my-like-score": 0,
        "restriction-reason": null,
        "introduced-total-views": 0
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/account",
            "related": "http://test.host/api/v2/insights/78/account"
          }
        },
        "images": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/images",
            "related": "http://test.host/api/v2/insights/78/images"
          }
        },
        "content-verticals": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/content-verticals",
            "related": "http://test.host/api/v2/insights/78/content-verticals"
          }
        },
        "primary-entity": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/primary-entity",
            "related": "http://test.host/api/v2/insights/78/primary-entity"
          }
        },
        "secondary-entities": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/secondary-entities",
            "related": "http://test.host/api/v2/insights/78/secondary-entities"
          }
        },
        "activities": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/activities",
            "related": "http://test.host/api/v2/insights/78/activities"
          }
        },
        "upstream-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/upstream-insights",
            "related": "http://test.host/api/v2/insights/78/upstream-insights"
          }
        },
        "downstream-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/downstream-insights",
            "related": "http://test.host/api/v2/insights/78/downstream-insights"
          }
        },
        "main-insight-document": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/main-insight-document",
            "related": "http://test.host/api/v2/insights/78/main-insight-document"
          }
        },
        "insight-documents": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/insight-documents",
            "related": "http://test.host/api/v2/insights/78/insight-documents"
          }
        },
        "insight-disclosures": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/insight-disclosures",
            "related": "http://test.host/api/v2/insights/78/insight-disclosures"
          }
        },
        "comment-threads": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/comment-threads",
            "related": "http://test.host/api/v2/insights/78/comment-threads"
          }
        },
        "originated-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/originated-insights",
            "related": "http://test.host/api/v2/insights/78/originated-insights"
          }
        },
        "comments": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/comments",
            "related": "http://test.host/api/v2/insights/78/comments"
          }
        },
        "suggested-forkable-insights": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/suggested-forkable-insights",
            "related": "http://test.host/api/v2/insights/78/suggested-forkable-insights"
          }
        },
        "citations": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/citations",
            "related": "http://test.host/api/v2/insights/78/citations"
          }
        },
        "annotations": {
          "links": {
            "self": "http://test.host/api/v2/insights/78/relationships/annotations",
            "related": "http://test.host/api/v2/insights/78/annotations"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "record-count": 2
  },
  "links": {
    "first": "http://test.host/api/v2/insights?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/insights?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

POST /api/v2/insights
Create Insight

Examples

POST /api/v2/insights
{
  "data": {
    "type": "insights",
    "attributes": {
      "tagline": null,
      "executive-summary": null,
      "time-horizon": "short",
      "imperative": null,
      "slug": null,
      "published-at": null,
      "format-type": "quick-note",
      "total-combined-read": "0",
      "countries": [],
      "strategies": [],
      "automatic-keywords": [],
      "custom-keywords": [],
      "gics": {
        "sectors": [],
        "industry-groups": [],
        "industries": []
      }
    },
    "relationships": {}
  }
}
401
{
  "errors": [
    {
      "title": "You are not authorized to access this request"
    }
  ]
}

GET /api/v2/insights/:id
Show an insight

Examples

GET /api/v2/insights/eum-explicabo-aperiam-sequi-sed-suscipit
200
{
  "data": {
    "id": "125",
    "type": "insights",
    "links": {
      "self": "http://test.host/api/v2/insights/125"
    },
    "attributes": {
      "countries": [
        "Singapore"
      ],
      "strategies": [
        "Growth"
      ],
      "imperative": "bullish",
      "slug": "eum-explicabo-aperiam-sequi-sed-suscipit",
      "published-at": "2017-08-29T08:46:06.719+08:00",
      "time-horizon": "short",
      "aasm-state": "published",
      "format-type": "in-depth",
      "show-author-names": true,
      "tagline": "Eum Explicabo Aperiam Sequi Sed Suscipit",
      "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.",
      "detail": "While a detailed examination of interest rates is a topic for another article,\nthere are several reasons why U.S. interest rates could remain low\nfor some time to come: European 10-year bonds in Italy and Spain are hitting\nall-time lows, with German 2-year bonds also hitting multi-year lows, and\nthe cash-and-carry trade will tend to arbitrage U.S. Treasury yields lower as\na result; Many see the likelihood that European Central Bank policy will\ncontinue to loosen, keeping European bond rates low;\n",
      "gics": {
        "sectors": [
          "Energy"
        ],
        "industry-groups": [],
        "industries": []
      },
      "total-account-read": 0,
      "total-public-read": 0,
      "total-combined-read": 0,
      "annotations-count": 0,
      "comments-count": 0,
      "total-discussions": 0,
      "published-forked-count": 0,
      "automatic-keywords": [
        "Global",
        "Growth",
        "Energy"
      ],
      "custom-keywords": [],
      "updated-at": "2017-08-29T10:46:06.962+08:00",
      "aasm-state-updated-at": null,
      "is-sk-content": true,
      "linkback": null,
      "likes-count": 0,
      "dislikes-count": 0,
      "no-sector": false,
      "is-read": false,
      "viewer-is-restricted": false,
      "my-like-score": 0,
      "weighted-insight-views": 0,
      "restriction-reason": null,
      "introduced-total-views": 0
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/account",
          "related": "http://test.host/api/v2/insights/125/account"
        }
      },
      "images": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/images",
          "related": "http://test.host/api/v2/insights/125/images"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/content-verticals",
          "related": "http://test.host/api/v2/insights/125/content-verticals"
        }
      },
      "primary-entity": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/primary-entity",
          "related": "http://test.host/api/v2/insights/125/primary-entity"
        }
      },
      "secondary-entities": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/secondary-entities",
          "related": "http://test.host/api/v2/insights/125/secondary-entities"
        }
      },
      "activities": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/activities",
          "related": "http://test.host/api/v2/insights/125/activities"
        }
      },
      "upstream-insights": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/upstream-insights",
          "related": "http://test.host/api/v2/insights/125/upstream-insights"
        }
      },
      "downstream-insights": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/downstream-insights",
          "related": "http://test.host/api/v2/insights/125/downstream-insights"
        }
      },
      "main-insight-document": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/main-insight-document",
          "related": "http://test.host/api/v2/insights/125/main-insight-document"
        }
      },
      "insight-documents": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/insight-documents",
          "related": "http://test.host/api/v2/insights/125/insight-documents"
        }
      },
      "insight-disclosures": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/insight-disclosures",
          "related": "http://test.host/api/v2/insights/125/insight-disclosures"
        }
      },
      "comment-threads": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/comment-threads",
          "related": "http://test.host/api/v2/insights/125/comment-threads"
        }
      },
      "originated-insights": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/originated-insights",
          "related": "http://test.host/api/v2/insights/125/originated-insights"
        }
      },
      "comments": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/comments",
          "related": "http://test.host/api/v2/insights/125/comments"
        }
      },
      "suggested-forkable-insights": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/suggested-forkable-insights",
          "related": "http://test.host/api/v2/insights/125/suggested-forkable-insights"
        }
      },
      "citations": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/citations",
          "related": "http://test.host/api/v2/insights/125/citations"
        }
      },
      "annotations": {
        "links": {
          "self": "http://test.host/api/v2/insights/125/relationships/annotations",
          "related": "http://test.host/api/v2/insights/125/annotations"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Insight ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/insights/:id
Update an Insight

Examples

PATCH /api/v2/insights/229
{
  "data": {
    "id": "229",
    "type": "insights",
    "attributes": {
      "tagline": "Fugiat Ea Aut Fuga",
      "executive-summary": null,
      "time-horizon": "short",
      "imperative": null,
      "slug": null,
      "published-at": null,
      "format-type": "quick-note",
      "total-combined-read": "0",
      "countries": [],
      "strategies": [],
      "automatic-keywords": [],
      "custom-keywords": [],
      "gics": {
        "sectors": [],
        "industry-groups": [],
        "industries": []
      }
    },
    "relationships": {}
  }
}
401
{
  "errors": [
    {
      "title": "You are not authorized to access this request"
    }
  ]
}

Params

Param name Description
id
required

Insight ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/insights/:id/like
Like an Insight


PATCH /api/v2/insights/:id/dislike
Dislike an Insight


PATCH /api/v2/insights/:id/unlike
Undo like/dislike an insight


DELETE /api/v2/insights/:id
Delete an unpublished insight

Examples

DELETE /api/v2/insights/124
401
{
  "errors": [
    {
      "title": "You are not authorized to access this request"
    }
  ]
}

Params

Param name Description
id
required

Insight ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/insights/:id/request-publication-access

Examples

POST /api/v2/insights/69/request-publication-access
{}
200
{
  "message": "Request has been sent!"
}

Params

Param name Description
id
required

Insight ID/slug

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.