Journey Overview Reporting API

Modified on Wed, 4 Mar at 3:01 PM

Scope

Aggregated statistics across journeys

Authentication

All endpoints:

Method: GET
Authentication: API Key required
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 Journey Overview Reporting API endpoints. The “Required” column indicates whether a parameter must be included in the endpoints.

Name	Type	Required	Description
siteId	number	Yes	Identifier of the Site
dateTo	date (YYYY-MM-DD or YYYY-M-D)	Yes	End date of reporting period
dateFrom	date (YYYY-MM-DD or YYYY-M-D)	No	Start date of reporting period
showDeletedContent	boolean	No	Include deleted Journeys in response
segmentIds	list	No	Optional Segment filter. Only data flagged with provided segment IDs during collection will be returned

Time Aggregation and Period Formatting

Some reporting endpoints support time-based aggregation via the period or periodKind query parameter.

Note: The parameter name differs between endpoints:

/usersEngagement → period
/trend → periodKind

Both parameters define the same aggregation granularity.

Allowed Values

YEAR, MONTH, WEEK, DAY

Period Field Format in Response

For endpoints that return aggregated time-series data (usersEngagement, trend), the format of the period field depends on the selected aggregation level:

Aggregation	period Format
YEAR	yyyy
MONTH	MM.yyyy
WEEK	w-yyyy
DAY	dd.MM

The period field is a formatted label intended for presentation.

1. Journeys Summary Engagement

Endpoint

GET /newired/rest/report/journeys/summaryEngagement

Description

Returns overall engagement statistics for journeys within the given period.

Query Parameters

Uses common parameters.

Response (200 OK)

{
  "engagedUsers": number,
  "journeysCompleted": number,
  "journeysLaunched": number,
  "usesEngagement": number
}

Fields

Field	Type	Description
engagedUsers	number	Total amount of unique users that have interacted with your Journeys in the selected timeframe
journeysCompleted	number	Total amount of Journeys completed by your users in the selected timeframe
journeysLaunched	number	Total amount of Journeys launched by your users in the selected timeframe
usesEngagement	number	Variation in the number of interactions with your DAP in the selected timeframe, expressed in percentage

Example Response

{
  "engagedUsers": 199,
  "journeysLaunched": 2915,
  "journeysCompleted": 2867,
  "usesEngagement": 7
}

2. Journeys Users Engagement

Endpoint

GET /newired/rest/report/journeys/usersEngagement

Additional Query Parameter

Name	Type	Required	Description
period	enum (e.g., MONTH)	Yes	Defines the time granularity used to aggregate and partition the response data (YEAR, MONTH, WEEK, DAY). The selected aggregation period should be aligned with the requested date range to avoid overly granular or excessively coarse results.

Allowed values: YEAR, MONTH, WEEK, DAY

Description

Returns engagement metrics aggregated per selected time period.

Response (200 OK)

{
  "engagedUsers": number,
  "journeysIssues": number,
  "journeysLaunched": number,
  "values": [
    {
      "fromDate": "yyyy-MM-dd HH:mm",
      "issues": number,
      "launched": number,
      "period": "MM.yyyy",
      "visits": number
    }
  ]
}

Fields

Field	Type	Description
engagedUsers	number	Total engaged users
journeysIssues	number	Total journeys with issues
journeysLaunched	number	Total launched journeys
values	array	Period breakdown

values object

Field	Type	Description
fromDate	datetime	Start date of the period
issues	number	Number of issues in period
launched	number	Journeys launched in period
period	string	Period label
visits	number	Number of visits

Example Response

{
  "engagedUsers": 199,
  "journeysIssues": 1,
  "journeysLaunched": 1336,
  "values": [
    {
      "fromDate": "2022-02-01 00:00",
      "period": "02.2022",
      "launched": 34,
      "visits": 34,
      "issues": 0
    },
    {
      "fromDate": "2022-03-01 00:00",
      "period": "03.2022",
      "launched": 674,
      "visits": 135,
      "issues": 0
    },
    {
      "fromDate": "2022-04-01 00:00",
      "period": "04.2022",
      "launched": 628,
      "visits": 135,
      "issues": 1
    }
  ]
}

The format of the period field follows the rules described in Time Aggregation and Period Formatting.

3. Journeys Usage

Endpoint

GET /newired/rest/report/journeys/usage

Description

Returns per-journey usage statistics within the selected period.

Response (200 OK)

Array of journey usage objects:

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

Fields

Field	Type	Description
id	number	Journey identifier
name	string	Journey name
startedCount	number	Number of starts
successCount	number	Successful completions
failedCount	number	Failed executions
dropOffCount	number	Drop-offs
noDataCount	number	Number of times the Journey 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 Journey is deleted

Example Response

[
  {
    "id": 1053,
    "name": "Journey_1",
    "startedCount": 92,
    "successCount": 90,
    "failedCount": 1,
    "dropOffCount": 1,
    "noDataCount": 0,
    "uniqueUsersCount": 92,
    "percentFinishCount": 97.83,
    "percentFinishUsers": 97.83,
    "deleted": false
  },
  {
    "id": 1054,
    "name": "Journey_2",
    "startedCount": 95,
    "successCount": 95,
    "failedCount": 0,
    "dropOffCount": 0,
    "noDataCount": 0,
    "uniqueUsersCount": 95,
    "percentFinishCount": 100.0,
    "percentFinishUsers": 100.0,
    "deleted": false
  }
]

4. Journeys Trend

Endpoint

GET /newired/rest/report/journeys/trend

Additional Query Parameter

Name	Type	Required	Description
periodKind	enum (e.g., MONTH)	Yes	Defines the time granularity used to aggregate and partition the response data (YEAR, MONTH, WEEK, DAY). The selected aggregation period should be aligned with the requested date range to avoid overly granular or excessively coarse results.

Description

Returns time-based trend statistics per journey.

Response (200 OK)

Array of journeys:

[
  {
    "id": number,
    "name": string,
    "values": [
      {
        "fromDate": "yyyy-MM-dd HH:mm",
        "period": "MM.yyyy",
        "started": { "count": number, "percent": number },
        "success": { "count": number, "percent": number },
        "failed": { "count": number, "percent": number },
        "dropOff": { "count": number, "percent": number },
        "noData": { "count": number, "percent": number }
      }
    ],
    "deleted": boolean
  }
]

Fields

Journey object

Field	Type	Description
id	number	Journey identifier
name	string	Journey name
values	array	Period breakdown
deleted	boolean	Whether journey is deleted (in queried period)

values object

Each metric contains:

{
  "count": number,
  "percent": number
}

Metric	Description
started	Journey starts
success	Successful completions
failed	Failures
dropOff	Drop-offs
noData	Number of journey runs that could not be fully evaluated because the session ended unexpectedly before a final outcome was recorded (a user closed browser tab).

Example Response

[
  {
    "id": 1053,
    "name": "Journey_1",
    "deleted": false,
    "values": [
      {
        "fromDate": "2022-02-01 00:00",
        "period": "02.2022",
        "started": { "count": 10, "percent": 100.0 },
        "success": { "count": 9, "percent": 90.0 },
        "failed": { "count": 1, "percent": 10.0 },
        "dropOff": { "count": 0, "percent": 0.0 },
        "noData": { "count": 0, "percent": 0.0 }
      },
      {
        "fromDate": "2022-03-01 00:00",
        "period": "03.2022",
        "started": { "count": 28, "percent": 100.0 },
        "success": { "count": 28, "percent": 100.0 },
        "failed": { "count": 0, "percent": 0.0 },
        "dropOff": { "count": 0, "percent": 0.0 },
        "noData": { "count": 0, "percent": 0.0 }
      }
    ]
  }
]

The format of the period field follows the rules described in Time Aggregation and Period Formatting.