Skip to main content

SuggestionItemResult

What happened to one event in a batch.

indexinteger

The event's position in the suggestions array you sent. Results are returned in that order, so this is also the index of this result — but match on it rather than assuming, and it stays correct if that ever changes.

Example: 0
source_idstringnullable

The source_id of the event, echoed back so a result can be tied to its input without counting positions. Null if the event carried none.

Example: jxfeed-alice-20260914-a91c3f
statusstring

The outcome:

  • created — a new suggestion was added.
  • updated — an existing suggestion matching this source_id was changed.
  • unchanged — a match was found and nothing about it differed. Not an error; re-sending an unchanged feed is expected to land here.
  • error — the event was refused. See error.

Possible values: [created, updated, unchanged, error]

Example: created
id_suggestioninteger

The suggestion's ID. Present on created, updated, and unchanged; absent on error.

Example: 97
errorstring

Why the event was refused. Present only when status is error.

Example: A suggestion needs a start and end.
SuggestionItemResult
{
"index": 0,
"source_id": "jxfeed-alice-20260914-a91c3f",
"status": "created",
"id_suggestion": 97,
"error": "A suggestion needs a start and end."
}