Examples

GET /api/v2/insight-documents/2
200
{
  "data": {
    "id": "2",
    "type": "insight-documents",
    "links": {
      "self": "http://test.host/api/v2/insight-documents/2"
    },
    "attributes": {
      "source": "https://static-dev.smartkarma.com/insight_documents/sources/000/000/002/original/source_test.pdf?1503975141",
      "source-file-name": "source_test.pdf",
      "source-file-size": 1024,
      "source-updated-at": "2017-08-29T10:52:21.778+08:00",
      "source-content-type": "application/pdf",
      "title": null
    },
    "relationships": {
      "insight": {
        "links": {
          "self": "http://test.host/api/v2/insight-documents/2/relationships/insight",
          "related": "http://test.host/api/v2/insight-documents/2/insight"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Insight Document 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.