Journey Steps Reporting API

Modified on Wed, 4 Mar at 11:34 AM

Scope

Step-level analytics within a single journey

Authentication

All endpoints:

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

More details:

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

Common Query Parameters

The following query parameters are used across Steps Reporting API endpoints. The “Required” column indicates whether a parameter must be included (endpoints have different parameter sets).

Name	Type	Required	Description
dateFrom	date (YYYY-MM-DD or YYYY-M-D)	No	Start date of reporting period
dateTo	date (YYYY-MM-DD or YYYY-M-D)	Yes	End date of reporting period
journeyId	number	Yes	Identifier of the journey
segmentIds	list	No	Optional segment filter. Only data flagged with provided segment IDs during collection will be returned.

1. User Completion

Endpoint

GET /newired/rest/journey/userCompletion

Description

Returns user completion records for a specific journey within the given period.

Query Parameters

Name	Type	Required	Description
dateFrom	date	No	Start date of reporting period
dateTo	date	Yes	End date of reporting period
journeyId	number	Yes	Journey identifier
firstIndex	number	No	Paging offset (start index)
count	number	No	Page size. Limits the total number of returned records.
sortAsc	boolean	No	Sort direction (True / False). Sorting by user identification.
segmentIds	list	No	Optional segment filter

Response (200 OK)

{
  "total": number,
  "records": [
    {
      "completionState": "string",
      "completionTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS",
      "userIdent": "string"
    }
  ]
}

Fields

Field	Type	Description
total	number	Total number of matching records
records	array	Page of completion records
records[].completionState	string	Completion state (COMPLETED, STARTED, NOT_STARTED)
records[].completionTime	datetime	Completion timestamp
records[].userIdent	string	User identifier

Example Response

{
  "total": 2,
  "records": [
    {
      "completionState": "COMPLETED",
      "completionTime": "2022-03-03T21:20:42.349367",
      "userIdent": "user128"
    },
    {
      "completionState": "COMPLETED",
      "completionTime": "2022-03-03T05:33:15.460892",
      "userIdent": "user157"
    }
  ]
}

2. Steps Usage

Endpoint

GET /newired/rest/report/steps/usage

Description

Returns per-step usage statistics within the selected period.

Query Parameters

Name	Type	Required	Description
dateFrom	date	No	Start date of reporting period
dateTo	date	Yes	End date of reporting period
journeyId	number	Yes	Journey identifier
segmentIds	list	No	Optional segment filter

Response (200 OK)

Array of step usage objects:

[
  {
    "dropOffCount": number,
    "failedCount": number,
    "id": number,
    "name": "string",
    "noDataCount": number,
    "percentFinishCount": number,
    "percentFinishUsers": number,
    "startedCount": number,
    "successCount": number,
    "uniqueUsersCount": number,
    "deleted": boolean
  }
]

Fields

Field	Type	Description
id	number	Step identifier
name	string	Step name
startedCount	number	Number of starts
successCount	number	Successful completions
failedCount	number	Failed executions
dropOffCount	number	Drop-offs
noDataCount	number	Number of times the Step was displayed but the journey did not continue to the next step, so the final outcome of the step could not be determined.
uniqueUsersCount	number	Unique users
percentFinishCount	number	Completion percentage (count-based)
percentFinishUsers	number	Completion percentage (user-based)
deleted	boolean	Whether Step is deleted (in queried period)

Example Response

[
  {
    "dropOffCount": 0,
    "failedCount": 0,
    "id": 14862,
    "name": "Step_1",
    "noDataCount": 0,
    "percentFinishCount": 100.0,
    "percentFinishUsers": 100.0,
    "startedCount": 2,
    "successCount": 2,
    "uniqueUsersCount": 2,
    "deleted": false
  }
]

3. Steps Duration

Endpoint

GET /newired/rest/report/steps/duration

Description

Returns per-step duration statistics within the selected period.

Query Parameters

Name	Type	Required	Description
dateFrom	date	No	Start date of reporting period
dateTo	date	Yes	End date of reporting period
journeyId	number	Yes	Journey identifier
segmentIds	list	No	Optional segment filter

Response (200 OK)

Array of step duration objects:

[
  {
    "avg": number,
    "id": number,
    "max": number,
    "median": number,
    "min": number,
    "name": "string",
    "quartile1": number,
    "quartile3": number,
    "deleted": boolean
  }
]

Fields

Field	Type	Description
id	number	Step identifier
name	string	Step name
avg	number	Average duration
min	number	Minimum duration
max	number	Maximum duration
median	number	Median duration
quartile1	number	25th percentile
quartile3	number	75th percentile
deleted	boolean	Whether Step is deleted

Example Response

[
  {
    "avg": 180.0,
    "id": 14862,
    "max": 180.0,
    "median": 180.0,
    "min": 180.0,
    "name": "Step_1",
    "quartile1": 180.0,
    "quartile3": 180.0,
    "deleted": false
  }
]

4. Journey Trend

Endpoint

GET /newired/rest/report/journey/trend

Description

Returns time-based statistics for a specific journey. The response aggregates journey execution results over the selected time period and shows counts and percentages for each journey outcome (started, success, failed, drop-off, no data).

This endpoint is typically used to visualize journey performance trends over time.

Query Parameters

Name	Type	Required	Description
siteId	number	Yes	Site identifier
journeyId	number	Yes	Journey identifier
dateFrom	date (YYYY-MM-DD or YYYY-M-D)	No	Start date of reporting period
dateTo	date (YYYY-MM-DD or YYYY-M-D)	Yes	End date of reporting period
periodKind	enum	Yes	Aggregation period (DAY, WEEK, MONTH, YEAR)
segmentIds	list	No	Optional segment filter

Response (200 OK)

Returns an array containing trend data for the selected journey.

[
  {
    "id": 1063,
    "name": "Journey_11",
    "values": [
      {
        "fromDate": "2022-03-03 00:00",
        "period": "03.03",
        "started": {
          "count": 2,
          "percent": 100.0
        },
        "success": {
          "count": 2,
          "percent": 100.0
        },
        "failed": {
          "count": 0,
          "percent": 0.0
        },
        "dropOff": {
          "count": 0,
          "percent": 0.0
        },
        "noData": {
          "count": 0,
          "percent": 0.0
        }
      }
    ],
    "deleted": false
  }
]

Response Fields

Field	Type	Description
id	number	Journey identifier
name	string	Journey name
values	array	List of aggregated metrics for each period
deleted	boolean	Indicates whether the Journey is deleted

Period Values

Field	Type	Description
fromDate	datetime	Start of the aggregated period
period	string	Human-readable label of the aggregation period
started.count	number	Number of Journey runs started
started.percent	number	Percentage of started runs
success.count	number	Successfully completed runs
success.percent	number	Percentage of successful runs
failed.count	number	Failed runs
failed.percent	number	Percentage of failed runs
dropOff.count	number	Runs that ended with a drop-off
dropOff.percent	number	Percentage of drop-offs
noData.count	number	Number of journey runs that could not be fully evaluated because the session ended unexpectedly before a final outcome was recorded.
noData.percent	number	Percentage of runs that ended without a final result.

Notes

The percent values represent the proportion of each outcome relative to the total number of journey runs within the aggregated period.
The response contains one object per journey.
Each object includes a values array containing metrics grouped by the selected periodKind.
The period field format depends on the selected aggregation period.