Beast Insights
  1. Order Summary Data
Beast Insights
  • Order Summary Data
    • Order Summary (Event Date)
      POST
    • Cohort Summary (Initial Date)
      POST
  • BIN Routing
    • BIN Routing
      POST
  • Schemas
    • Schemas
      • PaginationInfo
      • OrderSummaryRecord
    • Response
      • UnauthorizedError
      • RateLimitError
      • BadRequestError
      • InternalServerError
    • ErrorResponse
    • SuccessResponse
    • BinRoutingRequest
    • OrderSummaryCohortRequest
    • OrderSummaryRequest
    • BinRoutingResponse
  1. Order Summary Data

Order Summary (Event Date)

POST
https://api.beastinsights.com/api/data
Order Summary Data

Order Summary (Event Date)#

This is the primary endpoint for retrieving order summary data. Data is organized by event date - the date when each transaction, refund, or chargeback actually occurred.

How It Works#

1. Basic Usage#

Provide just start_date and end_date to get all available data for the date range:
{
  "start_date": "2025-07-01",
  "end_date": "2025-07-30"
}

2. Grouping & Aggregation#

Use group_by to aggregate data by specific dimensions:
{
  "start_date": "2025-07-01",
  "end_date": "2025-07-30",
  "group_by": ["product_id"]
}
This returns one record per product with aggregated metrics.

3. Metric Selection#

Choose specific metrics to reduce response size:
{
  "start_date": "2025-07-01",
  "end_date": "2025-07-30",
  "metrics": ["revenue", "approvals", "attempts"],
  "group_by": ["product_id"]
}

4. Filtering#

Apply filters to narrow down results:
{
  "start_date": "2025-07-01",
  "end_date": "2025-07-30",
  "group_by": ["product_id"],
  "filters": {
    "product_id": 903,
    "sales_type": "Initials"
  }
}

Available Dimensions#

date, campaign_id, product_id, gateway_id, bin, affid, sub_affid
sales_type, refund_type, billing_cycle, price_point, alert_type
product_name, product_group, campaign_name, campaign_type
mcc, acquirer, gateway_alias, bank, card_brand, card_type

Available Metrics#

Core: approvals, attempts, revenue, cpa
Chargebacks: cb_count, cb_amount, cb_count_by_cb_date, cb_amount_by_cb_date
Refunds: refund_count, refund_amount, refund_count_by_refund_date, refund_amount_by_refund_date
Alerts: alert, alert_count, alert_by_alert_date, alert_count_by_alert_date
By Sales Type: initial_attempt, initial_approved, rebills_attempted, rebills_approved
New: net_approvals, approvals_organic

Use Cases#

Product Performance: Group by product_id to analyze revenue per product
Campaign Analysis: Group by campaign_id to measure campaign effectiveness
Gateway Comparison: Group by gateway_id to compare payment processor performance
Daily Trends: Group by date to see daily performance trends
Alert Analysis: Filter by alert_type (ETHOCA, CDRN, RDR) to analyze alert patterns

Important Notes#

Date Range Limit: Maximum 100 days between start_date and end_date
Response Limit: Maximum 1000 records per request
Rate Limiting: 5 requests per minute per client

Authentication#

Required headers: x-client-id and x-client-secret

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Data retrieved successfully
Headers

Body

🟠400Bad Request
🟠401Unauthorized
🟠429Too Many Requests
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.beastinsights.com/api/data' \
--header 'x-client-id;' \
--header 'x-client-secret;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_date": "2025-07-01",
    "end_date": "2025-07-30"
}'
Response Response Example
200 - Product performance data (grouped)
{
    "success": true,
    "code": 200,
    "message": "Order summary data retrieved successfully with grouping",
    "data": [
        {
            "product_id": 903,
            "revenue": 15248.75,
            "approvals": 284,
            "attempts": 356,
            "refund_amount": 1247.5
        },
        {
            "product_id": 904,
            "revenue": 8932.5,
            "approvals": 167,
            "attempts": 203,
            "refund_amount": 892.3
        }
    ],
    "pagination": {
        "total": 25,
        "limit": 100,
        "offset": 0,
        "has_more": false
    },
    "timestamp": "2025-08-05T10:30:00.000Z"
}
Modified at 2025-12-17 12:23:57
Next
Cohort Summary (Initial Date)
Built with