Insights Management

Store or update an insight record

This endpoint stores or updates an insight record for a specified object type. If duplicate records are found, the operation is rejected with an appropriate error message.

post/api/{objectName}/{recordId}/insights

Request

  • Base URL: https://api.reallysimplesystems.com
  • URL: https://api.reallysimplesystems.com/api/{objectName}/{recordId}/insights
  • Auth: HTTP bearer

Request body

datastring required

The request payload containing the fields to be saved or updated for the insight.

Example request

{
  "data": "{\"field1\": \"value1\", \"field2\": \"value2\"}"
}

Response

Insight saved or updated successfully.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Insight saved successfully.",
  "data": {
    "metadata": {
      "url": "http://api.example.com/api/account/42/insights",
      "list_url": "http://api.example.com/api/insights",
      "parent": "http://api.example.com/api/account/42",
      "object_type": "record",
      "record_type": "insight"
    },
    "record": {
      "field1": "value1",
      "field2": "value2"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.