Skip to content
SoundSyncAudio software platform

API Reference

Analytics API

Developer-authenticated analytics overview, CSV export, revenue summary, product performance, activity, and current charges endpoints.

SoundSync

Verified endpoints

These endpoints are route-backed in the current platform.

GET /api/developer/analytics/overview

Fetch developer analytics overview.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
Revenue, product, customer, activation, download, subscription, marketplace, promotion, and export-ready summary.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Keep date, product, currency and live/test scope aligned. Missing measurements are not certified zeroes; imported external amounts are not automatically funded managed-sale earnings.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "dateRange": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "comparisonRange": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "activeTab": {
      "type": "string"
    },
    "availableTabs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "productFilter": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "unavailableSections": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "kpis": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "currentMonthCharges": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "service_option": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "service_option_name": {
          "type": "string"
        },
        "service_active": {
          "type": "boolean"
        },
        "monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "storage_allowance_bytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "hosting_included": {
          "type": "boolean"
        },
        "checkout_included": {
          "type": "boolean"
        },
        "minimum_qualifying_basis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ]
        },
        "minimum_qualifying_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "service_policy_version": {
          "type": "string"
        },
        "developer_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "unledgered_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "platform_fees_from_direct_sales_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketplace_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_email_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "redemption_overage_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "minimum_adjustment_cents": {
          "type": "integer",
          "minimum": 0
        },
        "provider_processing_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "soundsync_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "pre_minimum_total_cents": {
          "type": "integer",
          "minimum": 0
        },
        "billable_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "current_total_if_billed_today_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_emails": {
          "type": "object",
          "properties": {
            "sent_this_month": {
              "type": "integer",
              "minimum": 0
            },
            "included": {
              "type": "integer",
              "minimum": 0
            },
            "monthly_included": {
              "type": "integer",
              "minimum": 0
            },
            "prior_month_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "month_to_date_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "remaining_included": {
              "type": "integer",
              "minimum": 0
            },
            "billable": {
              "type": "integer",
              "minimum": 0
            },
            "charge_cents": {
              "type": "integer",
              "minimum": 0
            },
            "rate_cents_per_1000": {
              "type": [
                "integer",
                "null"
              ]
            },
            "current_rate_cents_per_1000": {
              "type": "integer",
              "minimum": 0
            },
            "pricing_basis": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "line_items": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        }
      },
      "additionalProperties": true
    },
    "includeResellerSales": {
      "type": "boolean"
    },
    "resellerDataUnavailable": {
      "type": "boolean"
    },
    "resellerEstimatesIncomplete": {
      "type": "boolean"
    },
    "topProducts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "product": {
            "type": "string"
          },
          "revenueCents": {
            "type": "integer"
          },
          "orders": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      }
    },
    "recentActivity": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "status": {
            "type": "string"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "engagementSummary": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "customerGeography": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "revenueTimeSeries": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "trafficOverview": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "retentionSummary": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "technicalHealth": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "customerBehavior": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "insights": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "raw": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 500, 503.

GET /api/developer/analytics/overview/export.csv

Export analytics overview CSV.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
CSV file.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Keep date, product, currency and live/test scope aligned. Missing measurements are not certified zeroes; imported external amounts are not automatically funded managed-sale earnings.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (text/csv)

{
  "type": "string",
  "format": "binary"
}

Documented failures: 400, 500, 503.

GET /api/developer/analytics/revenue/summary

Fetch revenue summary.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
Revenue summary.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Requires all-products workspace scope. Aggregate customer metrics remain available; customer rows and subscription identities require customers.view. Order activity references require orders.view and ledger adjustment references require refunds.view.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "summary": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "start_date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "end_date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "gross_revenue_cents": {
          "type": "integer"
        },
        "net_revenue_cents": {
          "type": "integer"
        },
        "total_orders": {
          "type": "integer"
        },
        "developer_earnings_cents": {
          "type": "integer"
        },
        "platform_fees_cents": {
          "type": "integer"
        },
        "marketplace_fees_cents": {
          "type": "integer"
        },
        "refund_total_cents": {
          "type": "integer"
        },
        "chargeback_total_cents": {
          "type": "integer"
        },
        "disputed_total_cents": {
          "type": "integer"
        },
        "affiliate_share_cents": {
          "type": "integer"
        },
        "collaborator_share_cents": {
          "type": "integer"
        },
        "partner_processing_fee_cents": {
          "type": "integer"
        },
        "estimated_net_revenue_cents": {
          "type": "integer"
        },
        "unique_customers": {
          "type": "integer"
        },
        "subscription_metrics": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenue_breakdown": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "refund_tax_total_cents": {
          "type": "integer"
        },
        "product_adjustments_cents": {
          "type": "integer"
        },
        "earnings_before_recovery_waivers_cents": {
          "type": "integer"
        },
        "recovery_credit_cents": {
          "type": "integer"
        },
        "net_developer_refund_cents": {
          "type": "integer"
        },
        "payment_processing_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "processing_fee_pending_count": {
          "type": "integer",
          "minimum": 0
        },
        "net_after_processing_cents": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Unavailable while processing evidence is pending; not a confirmed zero or bank payout."
        }
      },
      "additionalProperties": true
    },
    "products": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "timeline": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "windows": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "unavailable_sections": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "dashboard_metrics": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "current_month_charges": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "service_option": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "service_option_name": {
          "type": "string"
        },
        "service_active": {
          "type": "boolean"
        },
        "monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "storage_allowance_bytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "hosting_included": {
          "type": "boolean"
        },
        "checkout_included": {
          "type": "boolean"
        },
        "minimum_qualifying_basis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ]
        },
        "minimum_qualifying_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "service_policy_version": {
          "type": "string"
        },
        "developer_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "unledgered_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "platform_fees_from_direct_sales_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketplace_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_email_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "redemption_overage_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "minimum_adjustment_cents": {
          "type": "integer",
          "minimum": 0
        },
        "provider_processing_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "soundsync_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "pre_minimum_total_cents": {
          "type": "integer",
          "minimum": 0
        },
        "billable_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "current_total_if_billed_today_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_emails": {
          "type": "object",
          "properties": {
            "sent_this_month": {
              "type": "integer",
              "minimum": 0
            },
            "included": {
              "type": "integer",
              "minimum": 0
            },
            "monthly_included": {
              "type": "integer",
              "minimum": 0
            },
            "prior_month_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "month_to_date_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "remaining_included": {
              "type": "integer",
              "minimum": 0
            },
            "billable": {
              "type": "integer",
              "minimum": 0
            },
            "charge_cents": {
              "type": "integer",
              "minimum": 0
            },
            "rate_cents_per_1000": {
              "type": [
                "integer",
                "null"
              ]
            },
            "current_rate_cents_per_1000": {
              "type": "integer",
              "minimum": 0
            },
            "pricing_basis": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "line_items": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        }
      },
      "additionalProperties": true
    },
    "activity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "email_marketing": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "subscription_analytics": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "calculation_rules": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 500, 503.

GET /api/developer/analytics/revenue/products

Fetch product revenue performance.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
Product revenue rows.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Requires all-products workspace scope, matching /api/developer/revenue/products.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string"
    },
    "start_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "integer",
            "minimum": 1
          },
          "product_name": {
            "type": "string"
          },
          "gross_revenue_cents": {
            "type": "integer"
          },
          "net_revenue_cents": {
            "type": "integer"
          },
          "estimated_net_revenue_cents": {
            "type": "integer"
          },
          "order_count": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 500, 503.

GET /api/developer/analytics/revenue/activity

Fetch revenue activity timeline.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
Activity rows.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Requires all-products workspace scope. source_id is null for orders without orders.view and ledger adjustments without refunds.view; aggregate amounts remain available.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string"
    },
    "start_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "limit": {
      "type": "integer"
    },
    "activity": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "source_id": {
            "type": [
              "string",
              "number",
              "null"
            ]
          },
          "occurred_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "amount_cents": {
            "type": [
              "integer",
              "null"
            ]
          },
          "currency": {
            "type": [
              "string",
              "null"
            ]
          },
          "product": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "integer",
                "minimum": 1
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "status": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "additionalProperties": true
      }
    },
    "backend_gaps": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 500, 503.

GET /api/developer/analytics/revenue/current-month-charges

Fetch current month charge summary.

Auth
Account Bearer session token
Scope
Authenticated developer workspace; the route permission and assigned-product scope are enforced server-side.
Request fields
  • query range: string
  • query startDate: string. Custom start; start/from aliases are accepted.
  • query endDate: string. Custom end; end/to aliases are accepted.
  • query productId: integer
  • query currency: string
  • query environment: string
  • query includeResellers: boolean
  • query tab: string
Returns
Current charge summary.
Side effects
Retrieves the authorized resource; any preparation or event recording is described in the operation notes.
Notes
Requires all-products workspace scope. Uses the current America/New_York calendar month, not a requested historical month.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "today",
        "7d",
        "30d",
        "90d",
        "current_month",
        "previous_month"
      ]
    },
    "required": false,
    "description": ""
  },
  {
    "name": "startDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom start; start/from aliases are accepted."
  },
  {
    "name": "endDate",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": "Custom end; end/to aliases are accepted."
  },
  {
    "name": "productId",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "required": false,
    "description": ""
  },
  {
    "name": "currency",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "environment",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "includeResellers",
    "in": "query",
    "schema": {
      "type": "boolean"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "tab",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "overview",
        "commerce",
        "products",
        "customers",
        "marketing",
        "engagement",
        "retention",
        "technical"
      ]
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "charges": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "service_option": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "service_option_name": {
          "type": "string"
        },
        "service_active": {
          "type": "boolean"
        },
        "monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_minimum_cents": {
          "type": "integer",
          "minimum": 0
        },
        "configured_monthly_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "storage_allowance_bytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "hosting_included": {
          "type": "boolean"
        },
        "checkout_included": {
          "type": "boolean"
        },
        "minimum_qualifying_basis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ]
        },
        "minimum_qualifying_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "service_policy_version": {
          "type": "string"
        },
        "developer_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "unledgered_service_fee_cents": {
          "type": "integer",
          "minimum": 0
        },
        "platform_fees_from_direct_sales_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketplace_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_email_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "redemption_overage_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "minimum_adjustment_cents": {
          "type": "integer",
          "minimum": 0
        },
        "provider_processing_fees_cents": {
          "type": "integer",
          "minimum": 0
        },
        "soundsync_charges_cents": {
          "type": "integer",
          "minimum": 0
        },
        "pre_minimum_total_cents": {
          "type": "integer",
          "minimum": 0
        },
        "billable_activity_cents": {
          "type": "integer",
          "minimum": 0
        },
        "current_total_if_billed_today_cents": {
          "type": "integer",
          "minimum": 0
        },
        "marketing_emails": {
          "type": "object",
          "properties": {
            "sent_this_month": {
              "type": "integer",
              "minimum": 0
            },
            "included": {
              "type": "integer",
              "minimum": 0
            },
            "monthly_included": {
              "type": "integer",
              "minimum": 0
            },
            "prior_month_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "month_to_date_quantity": {
              "type": "integer",
              "minimum": 0
            },
            "remaining_included": {
              "type": "integer",
              "minimum": 0
            },
            "billable": {
              "type": "integer",
              "minimum": 0
            },
            "charge_cents": {
              "type": "integer",
              "minimum": 0
            },
            "rate_cents_per_1000": {
              "type": [
                "integer",
                "null"
              ]
            },
            "current_rate_cents_per_1000": {
              "type": "integer",
              "minimum": 0
            },
            "pricing_basis": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "line_items": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 500, 503.

SoundSync

Additional reporting operations

Revenue and Activity API

Read-only reporting, shares and recorded payment issues.

Replace the old analytics report reads

GET /api/analytics and GET /api/analytics/geo return 410 LEGACY_ANALYTICS_REPORT_RETIRED. Use /api/developer/analytics/overview, its export and the current revenue APIs with workspace analytics permission and product scope. Public POST /api/analytics/events and /api/analytics/event collection remain unchanged.

Do not substitute known allocations for unknown net-after-processing

Revenue summaries return payment_processing_fee_cents, processing_fee_pending_count and nullable net_after_processing_cents. A pending count makes the net-after-processing value unavailable, not zero. estimated_net_revenue_cents and earnings_before_recovery_waivers_cents retain their original allocation and reconciliation meanings.

net_developer_refund_cents excludes refunded tax and includes verified recovery effects once. refund_total_cents and refund_tax_total_cents describe customer refunds and tax components; do not subtract both from net earnings again. Current charges expose the agreement's minimum_qualifying_basis and separate provider-processing amount.

Activity stays within the teammate's permitted records

The combined analytics activity feed follows assigned products, including its counts and product filters. An empty assignment returns no activity. Productless website events and workspace-wide email events are not included in a product-filtered feed; a mixed-product sale shows only its selected item amount.

Customer and visitor identity, serial details and private order references follow their separate record permissions. Free-text diagnostics and nested metadata need the complete supporting record permissions. Search runs after those fields are filtered, so a hidden email address cannot be used to identify activity. Authorized analytics remain available.

Workspace-wide revenue reports and their analytics aliases require all-products access. Aggregate totals do not grant access to customer lists, subscription identities, order references or individual refund records. Refund details require refund access; private customer/order searches also require those record permissions.