> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivolio.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server.

# Conversion journeys

GET /reports/journeys

Returns the top conversion paths along with path-length and time-lag
histograms over the lookback window.

Reference: https://docs.pivolio.com/api-reference/pivolio/attribution/journeys-report

## Authentication

- `X-Workspace-Id` header (required) — API Key authentication via header

## Request

### Query parameters

- `period` (enum, optional) — Reporting time windows accepted by the analytics endpoints.
  - Allowed values: `1h`, `24h`, `7d`, `30d`, `90d`
- `window_days` (integer, optional, default: 30)
- `limit` (integer, optional, default: 15)

## Response

### 200

Successful Response

- `top_paths` (list of PathItem, required)
- `length_histogram` (list of HistogramBin, required)
- `lag_histogram` (list of HistogramBin, required)
- `avg_path_length` (double, optional, default: 0)
- `avg_lag_hours` (double, optional, default: 0)
- `total_conversions` (integer, optional, default: 0)
- `total_revenue_usd_cents` (integer, optional, default: 0)
- `truncated` (boolean, optional, default: false)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (string, required)
- `code` (string, required)
- `errors` (list of FieldError, optional, nullable)

## Types

### PathItem

- `path` (list of string, required)
- `conversions` (integer, required)
- `revenue_usd_cents` (integer, required)

### HistogramBin

- `label` (string, required)
- `count` (integer, required)

### FieldError

- `field` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
{
  "top_paths": [
    {
      "path": [
        "Homepage > Product Page > Cart > Checkout"
      ],
      "conversions": 125,
      "revenue_cents": 987500
    },
    {
      "path": [
        "Email Campaign > Landing Page > Signup"
      ],
      "conversions": 78,
      "revenue_cents": 312000
    }
  ],
  "length_histogram": [
    {
      "label": "1 step",
      "count": 50
    },
    {
      "label": "2 steps",
      "count": 100
    },
    {
      "label": "3 steps",
      "count": 80
    },
    {
      "label": "4+ steps",
      "count": 20
    }
  ],
  "lag_histogram": [
    {
      "label": "0-1 hours",
      "count": 90
    },
    {
      "label": "1-6 hours",
      "count": 80
    },
    {
      "label": "6-24 hours",
      "count": 50
    },
    {
      "label": "1-3 days",
      "count": 30
    }
  ],
  "avg_path_length": 2.7,
  "avg_lag_hours": 4.3,
  "total_conversions": 223,
  "truncated": false,
  "total_revenue_cents": 1299500
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/reports/journeys"

headers = {"X-Workspace-Id": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/reports/journeys';
const options = {method: 'GET', headers: {'X-Workspace-Id': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/reports/journeys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Workspace-Id", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/reports/journeys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/reports/journeys")
  .header("X-Workspace-Id", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/reports/journeys', [
  'headers' => [
    'X-Workspace-Id' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/reports/journeys");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Workspace-Id", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Workspace-Id": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/reports/journeys")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```