Get Signal

Gets details about the specified signal.

Get details of the requested signal.

GETyouragentURL.symphony.com/agent/v1/signals/{id}/get

Path parameters

id*string

The ID of the signal to display.

Header parameters

Response

200400401403500

List of signals for the requesting user.

Body

application/json

namestring

Signal name

querystring

The query used to define this signal. The query is defined as "field:value" pairs combined by the operators "AND" or "OR". Supported fields are (case-insensitive): "author", "hashtag" and "cashtag". MUST contain at least one "hashtag" or "cashtag" definition.

visibleOnProfileboolean

Whether the signal is visible on its creator's profile

companyWideboolean

Whether the signal is a push signal

idstring

Signal ID

timestampinteger (int64)

Timestamp when the signal was created, in milliseconds since Jan 1 1970

companyWideboolean

Whether the signal is a push signal

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v1/signals/{id}/get', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403500

{
  "name": "text",
  "query": "text",
  "visibleOnProfile": false,
  "companyWide": false,
  "id": "text"
}