> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudcruise.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get run network traffic

> Returns all network traffic recorded for a run, in one response. Traffic is recorded for runs started with `debug: true` and for workflows with network listening enabled, on workers with network capture.

- Events are sorted oldest first. `retry` is the attempt that produced the event.
- Credentials (cookies, auth headers, tokens) are redacted. Bodies are kept: JSON, HTML, text and XML bodies up to 2 MB in debug runs, all other bodies up to 100 KB. `request_truncated` / `response_truncated` mark a cut body.
- One call returns at most 100 MB of bodies, counting only events it returns. Bodies beyond that are `null`, with `request_truncated` / `response_truncated` set; `omitted_bodies` counts them.
- If the workflow has Extract Network nodes with `full_request: true`, request bodies are kept only for those nodes' URLs; `request_body` is `null` for all other requests.
- `complete` is `false` while the run is still in progress; fetch again after it ends for the full traffic.
- By default, noise (preflights, analytics, assets, health pings, …) is filtered out. Pass `include_noise=true` to get every captured event.



## OpenAPI

````yaml run-api/run-api.yaml get /run/{session_id}/network
openapi: 3.1.0
info:
  title: CloudCruise Run API
  version: 0.1.0
  description: >-
    Endpoints for managing workflow executions, user interactions, and
    retrieving execution results.
servers:
  - url: https://api.cloudcruise.com
    description: CloudCruise Platform Production API Server
security:
  - AuthScheme: []
paths:
  /run/{session_id}/network:
    get:
      summary: Get run network traffic
      description: >-
        Returns all network traffic recorded for a run, in one response. Traffic
        is recorded for runs started with `debug: true` and for workflows with
        network listening enabled, on workers with network capture.


        - Events are sorted oldest first. `retry` is the attempt that produced
        the event.

        - Credentials (cookies, auth headers, tokens) are redacted. Bodies are
        kept: JSON, HTML, text and XML bodies up to 2 MB in debug runs, all
        other bodies up to 100 KB. `request_truncated` / `response_truncated`
        mark a cut body.

        - One call returns at most 100 MB of bodies, counting only events it
        returns. Bodies beyond that are `null`, with `request_truncated` /
        `response_truncated` set; `omitted_bodies` counts them.

        - If the workflow has Extract Network nodes with `full_request: true`,
        request bodies are kept only for those nodes' URLs; `request_body` is
        `null` for all other requests.

        - `complete` is `false` while the run is still in progress; fetch again
        after it ends for the full traffic.

        - By default, noise (preflights, analytics, assets, health pings, …) is
        filtered out. Pass `include_noise=true` to get every captured event.
      operationId: get_run_network
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier for the workflow execution session
        - name: include_noise
          in: query
          required: false
          schema:
            type: boolean
            default: false
            description: Return every captured event instead of filtering noise
      responses:
        '200':
          description: Network traffic successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunNetworkResponse'
        '404':
          description: Session not found
        '503':
          description: >-
            Some recorded traffic could not be read right now. Retry the
            request.
components:
  schemas:
    RunNetworkResponse:
      type: object
      description: All recorded network traffic of a workflow run
      properties:
        session_id:
          type: string
          format: uuid
          example: e5f6a7b8-9abc-4def-0123-56789abcdef0
          description: Unique identifier for the workflow execution session
        complete:
          type: boolean
          example: true
          description: True once the run has ended and all traffic has been stored
        omitted_bodies:
          type: integer
          example: 0
          description: >-
            Number of request and response bodies returned as `null` because
            this call's 100 MB body budget was used up
        events:
          type: array
          description: Recorded requests, oldest first
          items:
            $ref: '#/components/schemas/RunNetworkEvent'
      required:
        - session_id
        - complete
        - omitted_bodies
        - events
    RunNetworkEvent:
      type: object
      description: One recorded request and its response
      properties:
        id:
          type: string
          description: Event identifier, unique within one attempt
        retry:
          type: integer
          example: 0
          description: Attempt that produced the event (0 for the first attempt)
        timestamp:
          type: string
          format: date-time
          description: When the request was captured
        method:
          type: string
          example: POST
        status:
          type: integer
          example: 200
          description: HTTP status code (0 when no response was captured)
        url:
          type: string
          example: https://app.example.com/api/claims
        category:
          type: string
          enum:
            - api
            - graphql
            - analytics
            - feature_flags
            - maps
            - assets
            - unknown
          description: Traffic category
        content_type:
          type: string
          nullable: true
          example: application/json
          description: Response content type
        request_headers:
          type: object
          additionalProperties:
            type: string
          description: Request headers, with credentials redacted
        response_headers:
          type: object
          additionalProperties:
            type: string
          description: Response headers, with credentials redacted
        request_body:
          type: string
          nullable: true
          description: Request body, with credentials redacted
        response_body:
          type: string
          nullable: true
          description: Response body, with credentials redacted
        request_truncated:
          type: boolean
          description: >-
            True when the request body was cut at the size limit, or omitted
            because this call's 100 MB body budget was used up
        response_truncated:
          type: boolean
          description: >-
            True when the response body was cut at the size limit, or omitted
            because this call's 100 MB body budget was used up
  securitySchemes:
    AuthScheme:
      type: apiKey
      name: cc-key
      in: header
      description: >-
        API key-based authentication. Provide your CloudCruise API key in the
        cc-key header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.