Description

Retrieve a single story.

Request

HTTP Method: GET

Parameter Description
id The ID of the story to retrieve.
curl -X GET \
  https://<tenant-name>.tines.io/api/v1/stories/<story-id> \
  -H 'content-type: application/json' \
  -H 'x-user-email: <email-address' \
  -H 'x-user-token: <api-token>'

Response

A successful request will return a JSON object representing the specified story.

Field description

Parameter Description
id The story ID.
name The story name.
user_id ID of story owner.
created_at ISO 8601 Timestamp respresenting date and time the story was created.
updated_at ISO 8601 Timestamp respresenting date and time the story was last updated.
description A user-defined description of the story.

Sample response

{
    "id": 1,
    "name": "Simple story",
    "user_id": 1,
    "created_at": "2018-10-25T20:06:14.825Z",
    "updated_at": "2018-10-25T20:06:14.825Z",
    "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant. The alert will contain the type of alert (infection, ddos, credential stuffing, etc.) and details on any users affected. If the alert is related to an infection, based on the users job title, we will take a specific action.\r\n\r\nThe simple story is described in detail in the <a href=\"https://docs.tines.io/tines_quickstart_simple_story.html\">Tines Docs</a>.\r\n\r\nUse the following URL command (replace $webhook-url with the webhook URL in the ''Summary\" tab of the 'Receive events' agent) to send events to this story:\r\n\r\n<pre>curl $webhook-url -X POST -H \"Content-Type: application/json\" -d '{\"event_name\":\"My first event\",\"type\":\"infection\",\"users\":[{\"name\":\"alice\",\"age\":25,\"country\":\"US\",\"job\":\"Engineer\"},{\"name\":\"bob\",\"age\":20,\"country\":\"UK\",\"job\":\"Student\"},{\"name\":\"carol\",\"age\":61,\"country\":\"Ireland\",\"job\":\"CEO\"}]}'</pre>",
    "guid": "b7c81e0cb416ae8f4c00874ca7b1cdf8"
}