Share by link API | Insites Help Center

Generate a shareable link

Method: POST

Endpoint: https://api.insites.com/api/v1/share-link

Request body should be JSON encoded, and can include the following fields:

Property	Definition	Required
report_id	String – ID of report to share	Yes
sections	Array – The sections you would like to include in the shared link. Valid options are summary, detail, competitors, proposal and progress	Yes
version_id	String – The ID of a specific report version (defaults to latest if not provided).	No
include_agent	Boolean – Whether to include your company logo and sales rep name, phone number, job title etc as a header on the shared link.	No
agent_username	String – The Insites username from which to populate the header. Required if include_agent is true.	No
brand_id NEW	String – The ID of the brand that should be applied to the PDF (where the alternative brand feature is enabled).	No

Example request

curl "<https://api.insites.com/api/v1/share-link>" --header "api-key:[YOUR API KEY]" --data "{\\"report_id\\":\\"ABDEFGH1234567890\\",\\"sections\\":[\\"summary\\",\\"detail\\"]}"

Expected response

If successful, you would expect a 201 response, with a body like this:

{
  "share_link": { 
    "id":"abcdef",
    "path":"/share/abcdef",
    "valid_urls":[
      "<https://app.insites.com/share/abcdef>",
      "<http://customdomain.mycompany.com/share/abcdef>"
   ]
  }
}