Sending Feedback Reports via API

19 May 2025

    This API allows for the sending of Feedback reports to the GSE using standard POST requests.

    Feedback reports are sent typically as follow ups to new signal reports for the following reasons:

    • To report that action has been taken on a specific signal - e.g. a signal has been taken down or blocked
    • To report that no action has been taken on a specific signal e.g. the signal was a false positive or there was no evidence of abuse
    • To add further enrichment data to a specific signal to help build a bigger picture for a given signal.
    POST https://signals.gse.live/report/feedback

    Sending Signal Feedback

    Send feedback for one or more signals in the GSE.

    Payload Attributes

    Required attributes

    • Name
      signal
      Type
      string
      Description
      The signal for which this feedback is being reported
    • Name
      type
      Type
      string
      Description
      The type of feedback being supplied - this is one of 3 values:

      feedback_noaction - feedback sent to indicate that no action was taken for this signal (e.g. could be a false positive)
      feedback_actioned - feedback sent to indicate that action was taken (e.g. blocked, taken down etc)
      feedback_enriched - feedback sent to further enrich this signal (supplied as extra data)
    • Name
      role
      Type
      string
      Description
      Your role as a feedback supplier. Must be one of the following values:
      Loading options....
    • Name
      reason
      Type
      string
      Description
      A valid reason from the list below according to the type field supplied above. For feedback_enrichment you must still supply enrichment as a reason.
      Loading options....

    Optional attributes

    • Name
      source
      Type
      string
      Description
      If supplied, it tags the feedback back to a given source - this should be a valid source key for a source made available to you from the list below.
    • Name
      reason_other
      Type
      string
      Description
      If other_actioned or other_noaction is supplied for the reason field, this should be filled in to qualify further.
    • Name
      reporter
      Type
      string
      Description
      An optional reporter string identifying the source of the feedback - you can either use your account name or an alias or simply leave this blank for anonymous feedback.
    • Name
      extra_data
      Type
      object
      Description
      An extra data field supplied as a JSON object with key/value pairs. This must be supplied when the type is set to feedback_enrichment to encode the enrichment data to add to the signal. For other types of feedback this can optionally be supplied for additional context if desired.

    Response Attributes

    • Name
      adds
      Type
      number
      Description
      The number of successfully added new signal reports based on the passed request.
    • Name
      updates
      Type
      number
      Description
      Not used for new signal reports - always set to 0.
    • Name
      replaces
      Type
      number
      Description
      Not used for new signal reports - always set to 0.
    • Name
      deletes
      Type
      number
      Description
      Not used for new signal reports - always set to 0.
    • Name
      rejected
      Type
      number
      Description
      The number of signal reports which were not able to be added from the request (usually due to validation errors)
    • Name
      validationErrors
      Type
      object
      Description
      An object containing validation errors generated from the passed signal reports when one or more items has been rejected.

      An array of validation error objects will be returned under the add property of the returned object. This array will have a validation object for each rejected object passed in the request.

      Each validation object will have the following properties:

      itemNumber - identifies the numerical array item index for the rejected object within the supplied request payload array. validationErrors - An object with keys representing the fields which have failed validation. The value for each of these keys is a descriptive string identifying the reason for the field validation to have failed.

      It will only appear if the rejected field is > 0

    Request

    POST · /feedback
curl -X POST https://signals.gse.live/report/feedback \
-H "API-KEY: YOUR-API-KEY-HERE" \
-H "API-SECRET: YOUR-API-SECRET-HERE" \

    Payload

    [
  {
    "signal": "https://testsignal.com",
    "type": "feedback_action",
    "role": "banking",
    "source": "test",
    "reason": "blocked",
    "reason_other": "null",
    "reporter": "bob marley",
    "extra_data": {"key": "value"}
  },
  // ...
]

    Response

    [
  {
    "adds": 1,
    "updates": 0,
    "replaces": 0,
    "deletes": 0,
    "rejected": 2,
    "validationErrors": {"add":[{"itemNumber":0,"validationErrors":{"type":"Value required for type","reason":"Value required for reason"}},{"itemNumber":1,"validationErrors":{"type":"Value required for type","reason":"Value required for reason"}}]}
  },
  // ...
]
    PrevNext