Journey Feedback Reporting API

Modified on Wed, 4 Mar at 11:54 AM

Scope

Provides analytics and detailed records of user feedback submitted for Journeys and their Steps.

Authentication

All endpoints:

Method: GET
Header:
- nw-auth: <API_KEY>
- Content-Type: application/json

More details:

https://support.newired.com/a/solutions/articles/103000391563

1. Journey Feedback Summary

Endpoint

GET /newired/rest/report/feedbacks/journeys/summary

Description

Returns aggregated feedback statistics per Journey for the selected period.

Only Journeys that received feedback within the given period are returned.

Query Parameters

Name	Required	Description
siteId	Yes	Site identifier
dateTo	Yes	End date of reporting period
dateFrom	No	Start date of reporting period
showDeletedContent	No	Include deleted Journeys

Response (200 OK)

[
  {
    "id": 4917,
    "name": "Journey1",
    "started": 12,
    "finished": 10,
    "positive": 6,
    "neutral": 2,
    "negative": 2,
    "uniqueUsers": 8,
    "deleted": false
  }
]

Fields

Field	Type	Description
id	number	Journey identifier
name	string	Journey name
started	number	Number of Journey runs started
finished	number	Number of Journey runs completed
positive	number	Positive feedback count
neutral	number	Neutral feedback count
negative	number	Negative feedback count
uniqueUsers	number	Distinct users who submitted feedback
deleted	boolean	Whether Journey is deleted

2. Journey Feedback Details

Endpoint

GET /newired/rest/report/feedbacks/journey

Description

Returns paginated detailed feedback records for a specific Journey.

Query Parameters

Name	Required	Description
siteId	Yes	Site identifier
journeyId	Yes	Journey identifier
dateTo	Yes	End date of reporting period
dateFrom	No	Start date of reporting period
count	No	Page size
fromIndex	No	Paging offset
sort	No	Sort field (time / user / rating / step)
sortAsc	No	Sort direction (True / False)
showDeletedContent	No	Include deleted content

Response (200 OK)

{
  "total": 2,
  "records": [
    {
      "journeyId": 4917,
      "journeyName": "Journey1",
      "stepId": null,
      "stepName": null,
      "rating": 1,
      "note": "Completed successfully.",
      "user": "john.doe",
      "time": "2026-03-03 16:06",
      "deleted": false
    }
  ]
}

Fields

Field	Type	Description
total	number	Total number of feedback records
records[]	array	Page of feedback records
records[].rating	number	Rating value (1 = Positive, 2 = Neutral, 3 = Negative)
records[].note	string	User comment
records[].user	string	User identifier
records[].time	datetime	Feedback submission time
records[].stepId	number/null	Related Step identifier (if step-level feedback)
records[].stepName	string/null	Step name
records[].deleted	boolean	Whether Journey/Step entity is deleted

3. Step Feedback Summary

Endpoint

GET /newired/rest/report/feedbacks/steps

Description

Returns aggregated feedback counts per step within a specific journey.

Query Parameters

Name	Required	Description
siteId	Yes	Site identifier
journeyId	Yes	Journey identifier
dateTo	Yes	End date
dateFrom	No	Start date

Response (200 OK)

[
  {
    "id": 35301,
    "name": "Alpha",
    "positive": 5,
    "neutral": 1,
    "negative": 0,
    "deleted": false
  }
]

Fields

Field	Type	Description
id	number	Step identifier
name	string	Step name
positive	number	Positive feedback count
neutral	number	Neutral feedback count
negative	number	Negative feedback count
deleted	boolean	Whether Step is deleted

4. Journey Feedback Trend

Endpoint

GET /newired/rest/report/feedbacks/journey/trend

Description

Returns time-based aggregation of feedback ratings for a journey.

Query Parameters

Name	Required	Description
siteId	Yes	Site identifier
journeyId	Yes	Journey identifier
dateTo	Yes	End date
dateFrom	No	Start date
period	Yes	Aggregation period (DAY, WEEK, MONTH, YEAR)

Response (200 OK)

[
  {
    "fromDate": "2026-01-01 00:00",
    "period": "2026",
    "positive": {
      "count": 8,
      "percent": 66.7
    },
    "neutral": {
      "count": 2,
      "percent": 16.7
    },
    "negative": {
      "count": 2,
      "percent": 16.7
    }
  }
]

Fields

Field	Type	Description
fromDate	datetime	Start of aggregation period
period	string	Formatted period label
positive.count	number	Positive feedback count
positive.percent	number	Percentage of positive feedback
neutral.count	number	Neutral feedback count
neutral.percent	number	Percentage of neutral feedback
negative.count	number	Negative feedback count
negative.percent	number	Percentage of negative feedback

Notes

dateFrom and dateTo accept both YYYY-MM-DD and YYYY-M-D formats.
Rating values are fixed to 1–3 and mapped to sentiment categories.
Deleted Journeys/Steps can optionally be included using showDeletedContent=True.
Percent values are calculated relative to total feedback count within the selected aggregation period.