---
title: "Get Dashboard Summary"
method: POST
path: "/api/recon/v3/summary"
tags: ["Recon APIs"]
---

# Get Dashboard Summary

`POST /api/recon/v3/summary`

## Request

- Base URL: `https://api.portone.cloud`
- URL: `https://api.portone.cloud/api/recon/v3/summary`
- Auth: none declared

This endpoint is used to fetch the reconciliation output summary for a pair of data sources.

## Headers

- `X-Portone-Client-Key` string
- `Authorization` string
- `Content-Type` string

## Request body

- object
  - `from` string, required: The Start date of date range for which you want to analyze the summary
  - `to` string, required: The End date of date range for which you want to analyze the summary
  - `data_source_a` string, required: The first data_source_id for which you want to analyze the summary
  - `data_source_b` string, required: The second data_source_id for which you want to analyze the summary
  - `record_type` 'payment' | 'refund', required: payment for forward transactions and refund for recon of refund transactions
  - `brand_id` unknown[]: Array of brand_id, can be fetched from merchant-custom-data api
    - unknown
  - `marketplace_id` unknown[]: Array of marketplace_id, can be fetched from merchant-custom-data api
    - unknown
  - `country` unknown[]: Array of country, can be fetched from merchant-custom-data api
    - unknown
  - `currency` unknown[]: Array of currency, can be fetched from merchant-custom-data api
    - unknown
  - `environment` 'live' | 'sandbox', required: The environment of the transaction is either live OR sandbox

## Response `200`

OK

- object
  - `data` object
    - `dataFields` object[]: List of data fields related to transactions, settlements, and mismatches.
      - `column_category` string: The category of the data (e.g., transaction, settlement, mismatch).
      - `count` integer: Number of records.
      - `count_sku` integer: Count of SKU records (if applicable).
      - `data_source_id` string: Identifier of the data source (e.g., LAZADA_ORDER, LAZADA_SETTLEMENT).
      - `id` string: Unique ID for the data field.
      - `msm_id` integer: MSM (Market Source Model) ID.
      - `name` string: The display name of the data field.
      - `record_type` string: Type of record (e.g., payment).
      - `sliceSettings` object: Visual settings for chart slices.
        - `fill` string: Fill color of the slice.
        - `stroke` string: Stroke color of the slice.
      - `status` string: Reconciliation status (e.g., reconciled, unreconciled).
      - `value` number: The value associated with the data field.
      - `value_source_b` number: Secondary value source (if applicable).
      - `sub_text_1` string: Additional text related to the field.
      - `sub_text_2` string: Additional secondary text.
      - `amount_value` number: Value related to amount (if applicable).
    - `dataNodes` object[]: Connection between various data fields.
      - `from` string: Source data field ID.
      - `to` string: Target data field ID.
      - `value` number: Value transferred from the source to the target.
      - `weightedValue` number: Weighted value representing the importance of the transfer.
    - `unConnectedNodes` string[]: Nodes that are not connected to others.
  - `message` string: Description of the API request execution result.
  - `status_code` string: Status code of the API response.
  - `status_reason` string: Status reason of the API response.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/portone/apis/recon-apis.md) - [All operations](https://skmtc.dev/portone/apis/recon-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/portone/apis/recon-apis/revisions/fe87490291bb?raw)