fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6654

tsdk02 · 2024-11-25T08:40:46Z

Type of Change

Description

Fixing some bugs in metrics calculations for Payments page - Analytics V2 dashboard:

Successful Payments Distribution and Failure Payments Distribution: Excluded the following dropoffs from the denominator while calculating the rates
- Without smart retries - From Payment Intents
  - RequiresCustomerAction
  - RequiresPaymentMethod
  - RequiresMerchantAction
  - RequiresConfirmation
- With smart retries
  - AuthenticationFailed
  - PaymentMethodAwaited
  - DeviceDataCollectionPending
  - ConfirmationAwaited
  - Unresolved
Failure reasons: Removed limit by clause and extracting data for all error_reasons
Payments lifecycle: Updated the sankey response structure, now it will look like this:

  { 
    "count":"25",
    "first_attempt":0,
    "status":"requires_payment_method",
    "refunds_status":null,
    "dispute_status":null
  }

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

Fix bugs and send correct data to be displayed in the analytics v2 dashboard.

How did you test it?

Sankey:

curl --location 'http://localhost:8080/analytics/v1/org/metrics/sankey' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--header 'Origin: http://localhost:9000' \
--header 'Referer: http://localhost:9000/' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-site' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \
--header 'api-key: test_admin' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNTQ5ZTNkMmItMTY5Yi00NzUzLWJmNTQtZDcxMTM2YjRiN2JkIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzI2MDQ2MzI4Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTczMjYwODUzNCwib3JnX2lkIjoib3JnX1ZwU0hPanNZZkR2YWJWWUpnQ0FKIiwicHJvZmlsZV9pZCI6InByb192NXNGb0hlODBPZWlVbElvbm9jTSIsInRlbmFudF9pZCI6InB1YmxpYyJ9.tQYvWyhWQInhAymh0c4itE1CWVwhOG3L4_yHMY4RLkQ' \
--header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "macOS"' \
--data '{
    "startTime": "2024-05-11T00:30:00Z",
    "endTime": "2024-11-25T23:30:00Z"
}'

Response:

[
    {
        "count": 2,
        "status": "succeeded",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 0
    },
    {
        "count": 40,
        "status": "succeeded",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 1
    },
    {
        "count": 1,
        "status": "failed",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 0
    },
    {
        "count": 2,
        "status": "requires_confirmation",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 1
    },
    {
        "count": 3,
        "status": "failed",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 1
    },
    {
        "count": 2,
        "status": "requires_payment_method",
        "refunds_status": null,
        "dispute_status": null,
        "first_attempt": 1
    },
    {
        "count": 7,
        "status": "succeeded",
        "refunds_status": "partial_refunded",
        "dispute_status": null,
        "first_attempt": 1
    }
]

Payments Distribution

curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--header 'Origin: http://localhost:9000' \
--header 'Referer: http://localhost:9000/' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-site' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \
--header 'api-key: test_admin' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNTQ5ZTNkMmItMTY5Yi00NzUzLWJmNTQtZDcxMTM2YjRiN2JkIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzI2MDQ2MzI4Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTczMjYwODUzNCwib3JnX2lkIjoib3JnX1ZwU0hPanNZZkR2YWJWWUpnQ0FKIiwicHJvZmlsZV9pZCI6InByb192NXNGb0hlODBPZWlVbElvbm9jTSIsInRlbmFudF9pZCI6InB1YmxpYyJ9.tQYvWyhWQInhAymh0c4itE1CWVwhOG3L4_yHMY4RLkQ' \
--header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "macOS"' \
--data '[
    {
        "timeRange": {
            "startTime": "2024-11-19T00:30:00Z",
            "endTime": "2024-11-19T23:30:00Z"
        },
        "groupByNames": [
            "connector"
        ],
        "source": "BATCH",
        "metrics": [
            "payments_distribution"
        ],
        "delta": true
    }
]'

Response:

{
    "queryData": [
        {
            "payment_success_rate": null,
            "payment_count": null,
            "payment_success_count": null,
            "payment_processed_amount": 0,
            "payment_processed_amount_in_usd": null,
            "payment_processed_count": null,
            "payment_processed_amount_without_smart_retries": 0,
            "payment_processed_amount_without_smart_retries_usd": null,
            "payment_processed_count_without_smart_retries": null,
            "avg_ticket_size": null,
            "payment_error_message": null,
            "retries_count": null,
            "retries_amount_processed": 0,
            "connector_success_rate": null,
            "payments_success_rate_distribution": null,
            "payments_success_rate_distribution_without_smart_retries": null,
            "payments_success_rate_distribution_with_only_retries": null,
            "payments_failure_rate_distribution": null,
            "payments_failure_rate_distribution_without_smart_retries": null,
            "payments_failure_rate_distribution_with_only_retries": null,
            "failure_reason_count": 0,
            "failure_reason_count_without_smart_retries": 0,
            "currency": null,
            "status": null,
            "connector": null,
            "authentication_type": null,
            "payment_method": null,
            "payment_method_type": null,
            "client_source": null,
            "client_version": null,
            "profile_id": null,
            "card_network": null,
            "merchant_id": null,
            "card_last_4": null,
            "card_issuer": null,
            "error_reason": null,
            "time_range": {
                "start_time": "2024-11-19T00:30:00.000Z",
                "end_time": "2024-11-19T23:30:00.000Z"
            },
            "time_bucket": "2024-11-19 00:30:00"
        },
        {
            "payment_success_rate": null,
            "payment_count": null,
            "payment_success_count": null,
            "payment_processed_amount": 0,
            "payment_processed_amount_in_usd": null,
            "payment_processed_count": null,
            "payment_processed_amount_without_smart_retries": 0,
            "payment_processed_amount_without_smart_retries_usd": null,
            "payment_processed_count_without_smart_retries": null,
            "avg_ticket_size": null,
            "payment_error_message": null,
            "retries_count": null,
            "retries_amount_processed": 0,
            "connector_success_rate": null,
            "payments_success_rate_distribution": 88.88888888888889,
            "payments_success_rate_distribution_without_smart_retries": 87.5,
            "payments_success_rate_distribution_with_only_retries": 100.0,
            "payments_failure_rate_distribution": 11.11111111111111,
            "payments_failure_rate_distribution_without_smart_retries": 12.5,
            "payments_failure_rate_distribution_with_only_retries": 0.0,
            "failure_reason_count": 0,
            "failure_reason_count_without_smart_retries": 0,
            "currency": null,
            "status": null,
            "connector": "stripe_test",
            "authentication_type": null,
            "payment_method": null,
            "payment_method_type": null,
            "client_source": null,
            "client_version": null,
            "profile_id": null,
            "card_network": null,
            "merchant_id": null,
            "card_last_4": null,
            "card_issuer": null,
            "error_reason": null,
            "time_range": {
                "start_time": "2024-11-19T00:30:00.000Z",
                "end_time": "2024-11-19T23:30:00.000Z"
            },
            "time_bucket": "2024-11-19 00:30:00"
        }
    ],
    "metaData": [
        {
            "total_payment_processed_amount": 0,
            "total_payment_processed_amount_in_usd": 0,
            "total_payment_processed_amount_without_smart_retries": 0,
            "total_payment_processed_amount_without_smart_retries_usd": 0,
            "total_payment_processed_count": 0,
            "total_payment_processed_count_without_smart_retries": 0,
            "total_failure_reasons_count": 0,
            "total_failure_reasons_count_without_smart_retries": 0
        }
    ]
}

Failure Reasons:

curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--header 'Origin: http://localhost:9000' \
--header 'Referer: http://localhost:9000/' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-site' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \
--header 'api-key: test_admin' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNTQ5ZTNkMmItMTY5Yi00NzUzLWJmNTQtZDcxMTM2YjRiN2JkIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzI2MDQ2MzI4Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTczMjYwODUzNCwib3JnX2lkIjoib3JnX1ZwU0hPanNZZkR2YWJWWUpnQ0FKIiwicHJvZmlsZV9pZCI6InByb192NXNGb0hlODBPZWlVbElvbm9jTSIsInRlbmFudF9pZCI6InB1YmxpYyJ9.tQYvWyhWQInhAymh0c4itE1CWVwhOG3L4_yHMY4RLkQ' \
--header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "macOS"' \
--data '[
    {
        "timeRange": {
            "startTime": "2024-11-17T00:30:00Z",
            "endTime": "2024-11-25T23:30:00Z"
        },
        "groupByNames": [
            "connector", "error_reason"
        ],
        "source": "BATCH",
        "metrics": [
            "failure_reasons"
        ],
        "delta": true
    }
]'

Response:

{
    "queryData": [
        {
            "payment_success_rate": null,
            "payment_count": null,
            "payment_success_count": null,
            "payment_processed_amount": 0,
            "payment_processed_amount_in_usd": null,
            "payment_processed_count": null,
            "payment_processed_amount_without_smart_retries": 0,
            "payment_processed_amount_without_smart_retries_usd": null,
            "payment_processed_count_without_smart_retries": null,
            "avg_ticket_size": null,
            "payment_error_message": null,
            "retries_count": null,
            "retries_amount_processed": 0,
            "connector_success_rate": null,
            "payments_success_rate_distribution": null,
            "payments_success_rate_distribution_without_smart_retries": null,
            "payments_success_rate_distribution_with_only_retries": null,
            "payments_failure_rate_distribution": null,
            "payments_failure_rate_distribution_without_smart_retries": null,
            "payments_failure_rate_distribution_with_only_retries": null,
            "failure_reason_count": 1,
            "failure_reason_count_without_smart_retries": 1,
            "currency": null,
            "status": null,
            "connector": "stripe_test",
            "authentication_type": null,
            "payment_method": null,
            "payment_method_type": null,
            "client_source": null,
            "client_version": null,
            "profile_id": null,
            "card_network": null,
            "merchant_id": null,
            "card_last_4": null,
            "card_issuer": null,
            "error_reason": "TEST ERROR - 1",
            "time_range": {
                "start_time": "2024-11-17T00:30:00.000Z",
                "end_time": "2024-11-25T23:30:00.000Z"
            },
            "time_bucket": "2024-11-17 00:30:00"
        }
    ],
    "metaData": [
        {
            "total_payment_processed_amount": 0,
            "total_payment_processed_amount_in_usd": 0,
            "total_payment_processed_amount_without_smart_retries": 0,
            "total_payment_processed_amount_without_smart_retries_usd": 0,
            "total_payment_processed_count": 0,
            "total_payment_processed_count_without_smart_retries": 0,
            "total_failure_reasons_count": 1,
            "total_failure_reasons_count_without_smart_retries": 1
        }
    ]
}

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

… dropoffs in payment_distributions

semanticdiff-com · 2024-11-25T08:40:50Z

Review changes with

Changed Files

File	Status
crates/analytics/src/payments/accumulator.rs	64% smaller
crates/analytics/src/payment_intents/accumulator.rs	40% smaller
crates/api_models/src/analytics.rs	31% smaller
crates/analytics/src/payment_intents/sankey.rs	22% smaller
crates/analytics/src/payment_intents/core.rs	4% smaller
crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs	0% smaller

…t distributions

…ed-cypress * 'main' of github.com:juspay/hyperswitch: feat: add support for sdk session call in v2 (#6502) fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard (#6654) ci(cypress): Added Config Testcases (#6622)

fix(analytics): remove limit by clause in failure_reasons and exclude…

2e1e405

… dropoffs in payment_distributions

tsdk02 added C-bug Category: Bug A-Analytics labels Nov 25, 2024

tsdk02 self-assigned this Nov 25, 2024

tsdk02 requested a review from a team as a code owner November 25, 2024 08:40

tsdk02 linked an issue Nov 25, 2024 that may be closed by this pull request

fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6653

Closed

tsdk02 added 2 commits November 25, 2024 15:19

fix(analytics): add AttemptStatus::Unresolved as a dropoff for paymen…

c997968

…t distributions

fix(analytics): update sankey response structure

b30a287

tsdk02 requested review from SanchithHegde and ShivanshMathurJuspay November 25, 2024 13:18

SanchithHegde approved these changes Nov 25, 2024

View reviewed changes

ShivanshMathurJuspay approved these changes Nov 25, 2024

View reviewed changes

Merge branch 'main' into fix-payment-metrics-analytics-v2

407ab07

likhinbopanna added this pull request to the merge queue Nov 28, 2024

Merged via the queue into main with commit 93459fd Nov 28, 2024
27 of 29 checks passed

likhinbopanna deleted the fix-payment-metrics-analytics-v2 branch November 28, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6654

fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6654

tsdk02 commented Nov 25, 2024 •

edited

Loading

semanticdiff-com bot commented Nov 25, 2024 •

edited

Loading

fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6654

fix(analytics): fix bugs in payments page metrics in Analytics V2 dashboard #6654

Conversation

tsdk02 commented Nov 25, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Nov 25, 2024 • edited Loading

tsdk02 commented Nov 25, 2024 •

edited

Loading

semanticdiff-com bot commented Nov 25, 2024 •

edited

Loading