Sending Signals
24 March 2025
Sending Signals
Insert a set of new rows to the Signal feed
Payload Attributes
Required attributes
- Name
signal
- Type
- mediumstring
- Description
- The signal you want to share.
- Name
report_date
- Type
- datetime
- Description
- Date & time the signal was reported.
- Name
abuse_type
- Type
- string
- Description
- The type of abuse this signal represents. Must be one of the following types...
If you would like to send us a different abuse type, please contact us
- Loading options....
Optional attributes
- Name
predictive
- Type
- boolean
- Description
- An indication that this signal was generated using an algorithm rather than confirmed report.
- Name
confidence_score
- Type
- integer
- Description
- Number between 0-100. A score of 100 would indicate the highest confidence in this signal
- Name
signal_type
- Type
- string
- Description
- The type of signal. If supplied, must be one of the following...
If not supplied we will attempt to detect this.
If you would like to send us a different signal type, please contact us - Loading options....
- Name
extra_data
- Type
- object
- Description
- Vendor specific extra data optionally supplied to further qualify the signal if desired. This allows for additional classification of data and/or additional abuse type specific fields.
This should be supplied as a standard top level JSON object with key / value pairs. Nested object and arrays are permitted.
Request
POST · /signal
curl -X POST https://signals.gse.live/report/signal \
-H "API-KEY: YOUR-API-KEY-HERE" \
-H "API-SECRET: YOUR-API-SECRET-HERE" \
Payload
[
{
"signal": "https://somesignal.com",
"report_date": "2020-01-23 14:24:06",
"abuse_type": "phishing",
"signal_type": "url",
"predictive": "false",
"confidence_score": "85",
"extra_data": "{"category": "internal", "collection_method": "form_submission"}"
},
// ...
]
List all of the signals you have sent
Return all of the imported signals you have uploaded via your account.
Request Attributes
Required attributes
- Name
limit
- Type
- integer
- Description
- Limit the number of results to the supplied number
- Name
offset
- Type
- integer
- Description
- Offset the results by the supplied number
Defaults to 0
- Name
sort
- Type
- string
- Description
- Sort the results by supplying a column name and direction. eg signal|desc
- Name
filter_{COLUMNNAME}
- Type
- string
- Description
- Filtering of the returned data can be effected by supplying parameters of the format filter_COLUMNNAME. The parameter value can either be simply a value for exact match filtering or a value followed by a | and a match type which should be one of the following values:
Example: filter_signal=somesignal|contains
Response Attributes
- Name
signal
- Type
- string
- Description
- The signal you want to share.
- Name
report_date
- Type
- datetime
- Description
- Date & time the signal was reported.
- Name
abuse_type
- Type
- string
- Description
- The type of abuse this signal represents. Must be one of the following types...
e.g. phishing, malware
If you would like to send us a different abuse type, please contact us - Loading options....
- Name
signal_type
- Type
- string
- Description
- The type of signal. If supplied, must be one of the following.
e.g. url,hostname
If not supplied we will attempt to detect this. If you would like to send us a different signal type, please contact us
- Loading options....
- Name
predictive
- Type
- boolean
- Description
- An indication that this signal was generated using an algorithm rather than confirmed report.
- Name
confidence_score
- Type
- integer
- Description
- Number between 0-100. A score of 100 would indicate the highest confidence in this signal
- Name
extra_data
- Type
- object
- Description
- Vendor specific extra data optionally supplied to further qualify the signal if desired. This allows for additional classification of data and/or additional abuse type specific fields.
This should be formatted as a standard top level JSON object with key / value pairs. Nested object and arrays are permitted.
Request
GET · /signal
curl -X GET https://signals.gse.live/report/signal \
-H "API-KEY: YOUR-API-KEY-HERE" \
-H "API-SECRET: YOUR-API-SECRET-HERE" \ \
-d "limit=[[value]]" \
-d "offset=[[value]]" \
-d "sort=[[value]]" \
-d "filter_{COLUMNNAME}=[[value]]" \
Response
[
{
"signal": "https://somesignal.com",
"report_date": "2020-01-23 14:24:06",
"abuse_type": "phishing",
"signal_type": "phishing",
"predictive": "false",
"confidence_score": "85",
"extra_data": "{"category": "internal", "collection_method": "form_submission"}"
},
// ...
]