Skip to main content
POST
/
events
/
analytics
Get usage analytics
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/events/analytics \
  --header 'Content-Type: */*' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "end_time": "<string>",
  "expand": [
    "<string>"
  ],
  "external_customer_id": "<string>",
  "feature_ids": [
    "<string>"
  ],
  "group_by": [
    "<string>"
  ],
  "property_filters": {},
  "sources": [
    "<string>"
  ],
  "start_time": "<string>",
  "window_size": "MINUTE"
}'
{
  "currency": "<string>",
  "items": [
    {
      "add_on_id": "<string>",
      "addon": {
        "created_at": "<string>",
        "created_by": "<string>",
        "description": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "type": "onetime",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "aggregation_type": "COUNT",
      "currency": "<string>",
      "event_count": 123,
      "event_name": "<string>",
      "feature": {
        "alert_settings": {
          "alert_enabled": true,
          "critical": {
            "condition": "<any>",
            "threshold": "<any>"
          },
          "info": {
            "condition": "<any>",
            "threshold": "<any>"
          },
          "warning": {
            "condition": "<any>",
            "threshold": "<any>"
          }
        },
        "created_at": "<string>",
        "created_by": "<string>",
        "description": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "meter_id": "<string>",
        "name": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "type": "metered",
        "unit_plural": "<string>",
        "unit_singular": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "feature_id": "<string>",
      "meter": {
        "aggregation": {
          "bucket_size": "MINUTE",
          "field": "<string>",
          "multiplier": 123,
          "type": "COUNT"
        },
        "created_at": "<string>",
        "created_by": "<string>",
        "environment_id": "<string>",
        "event_name": "<string>",
        "filters": [
          {
            "key": "<any>",
            "values": "<any>"
          }
        ],
        "id": "<string>",
        "name": "<string>",
        "reset_usage": "BILLING_PERIOD",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "meter_id": "<string>",
      "name": "<string>",
      "plan": {
        "created_at": "<string>",
        "created_by": "<string>",
        "description": "<string>",
        "display_order": 123,
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "plan_id": "<string>",
      "points": [
        {
          "cost": 123,
          "event_count": 123,
          "timestamp": "<string>",
          "usage": 123
        }
      ],
      "price": {
        "addon": {
          "created_at": "<string>",
          "created_by": "<string>",
          "description": "<string>",
          "entitlements": [
            {
              "addon": {},
              "created_at": "<string>",
              "created_by": "<string>",
              "display_order": 123,
              "entity_id": "<string>",
              "entity_type": "PLAN",
              "environment_id": "<string>",
              "feature": {
                "alert_settings": {
                  "alert_enabled": true,
                  "critical": {
                    "condition": "<any>",
                    "threshold": "<any>"
                  },
                  "info": {
                    "condition": "<any>",
                    "threshold": "<any>"
                  },
                  "warning": {
                    "condition": "<any>",
                    "threshold": "<any>"
                  }
                },
                "created_at": "<string>",
                "created_by": "<string>",
                "description": "<string>",
                "environment_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "meter": {
                  "aggregation": {
                    "bucket_size": "MINUTE",
                    "field": "<string>",
                    "multiplier": 123,
                    "type": "COUNT"
                  },
                  "created_at": "2024-03-20T15:04:05Z",
                  "event_name": "api_request",
                  "filters": [
                    {
                      "key": "<any>",
                      "values": "<any>"
                    }
                  ],
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "name": "API Usage Meter",
                  "reset_usage": "BILLING_PERIOD",
                  "status": "published",
                  "tenant_id": "tenant123",
                  "updated_at": "2024-03-20T15:04:05Z"
                },
                "meter_id": "<string>",
                "name": "<string>",
                "status": "published",
                "tenant_id": "<string>",
                "type": "metered",
                "unit_plural": "<string>",
                "unit_singular": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              },
              "feature_id": "<string>",
              "feature_type": "metered",
              "id": "<string>",
              "is_enabled": true,
              "is_soft_limit": true,
              "parent_entitlement_id": "<string>",
              "plan": {
                "created_at": "<string>",
                "created_by": "<string>",
                "credit_grants": [
                  {
                    "cadence": "ONETIME",
                    "created_at": "<string>",
                    "created_by": "<string>",
                    "credits": 123,
                    "environment_id": "<string>",
                    "expiration_duration": 123,
                    "expiration_duration_unit": "DAY",
                    "expiration_type": "NEVER",
                    "id": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "period": "DAILY",
                    "period_count": 123,
                    "plan_id": "<string>",
                    "priority": 123,
                    "scope": "PLAN",
                    "status": "published",
                    "subscription_id": "<string>",
                    "tenant_id": "<string>",
                    "updated_at": "<string>",
                    "updated_by": "<string>"
                  }
                ],
                "description": "<string>",
                "display_order": 123,
                "entitlements": [
                  {}
                ],
                "environment_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "name": "<string>",
                "prices": [
                  {}
                ],
                "status": "published",
                "tenant_id": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              },
              "plan_id": "<string>",
              "static_value": "<string>",
              "status": "published",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>",
              "usage_limit": 123,
              "usage_reset_period": "MONTHLY"
            }
          ],
          "environment_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "name": "<string>",
          "prices": [
            {}
          ],
          "status": "published",
          "tenant_id": "<string>",
          "type": "onetime",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "amount": 123,
        "billing_cadence": "RECURRING",
        "billing_model": "FLAT_FEE",
        "billing_period": "MONTHLY",
        "billing_period_count": 123,
        "conversion_rate": 123,
        "created_at": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "description": "<string>",
        "display_amount": "<string>",
        "display_price_unit_amount": "<string>",
        "end_date": "<string>",
        "entity_id": "<string>",
        "entity_type": "PLAN",
        "environment_id": "<string>",
        "group": {
          "created_at": "<string>",
          "entity_ids": [
            "<string>"
          ],
          "entity_type": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "<string>",
          "updated_at": "<string>"
        },
        "group_id": "<string>",
        "id": "<string>",
        "invoice_cadence": "ARREAR",
        "lookup_key": "<string>",
        "metadata": {},
        "meter": {
          "aggregation": {
            "bucket_size": "MINUTE",
            "field": "<string>",
            "multiplier": 123,
            "type": "COUNT"
          },
          "created_at": "2024-03-20T15:04:05Z",
          "event_name": "api_request",
          "filters": [
            {
              "key": "<any>",
              "values": "<any>"
            }
          ],
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "API Usage Meter",
          "reset_usage": "BILLING_PERIOD",
          "status": "published",
          "tenant_id": "tenant123",
          "updated_at": "2024-03-20T15:04:05Z"
        },
        "meter_id": "<string>",
        "parent_price_id": "<string>",
        "plan": {
          "created_at": "<string>",
          "created_by": "<string>",
          "credit_grants": [
            {
              "cadence": "ONETIME",
              "created_at": "<string>",
              "created_by": "<string>",
              "credits": 123,
              "environment_id": "<string>",
              "expiration_duration": 123,
              "expiration_duration_unit": "DAY",
              "expiration_type": "NEVER",
              "id": "<string>",
              "metadata": {},
              "name": "<string>",
              "period": "DAILY",
              "period_count": 123,
              "plan_id": "<string>",
              "priority": 123,
              "scope": "PLAN",
              "status": "published",
              "subscription_id": "<string>",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            }
          ],
          "description": "<string>",
          "display_order": 123,
          "entitlements": [
            {}
          ],
          "environment_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "name": "<string>",
          "prices": [
            {}
          ],
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "plan_id": "<string>",
        "price_unit": "<string>",
        "price_unit_amount": 123,
        "price_unit_id": "<string>",
        "price_unit_tiers": [
          {
            "flat_amount": 123,
            "unit_amount": 123,
            "up_to": 123
          }
        ],
        "price_unit_type": "FIAT",
        "pricing_unit": {
          "base_currency": "<string>",
          "code": "<string>",
          "conversion_rate": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "name": "<string>",
          "precision": 123,
          "status": "published",
          "symbol": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "start_date": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "tier_mode": "VOLUME",
        "tiers": [
          {
            "flat_amount": 123,
            "unit_amount": 123,
            "up_to": 123
          }
        ],
        "transform_quantity": {
          "divide_by": 123,
          "round": "<string>"
        },
        "trial_period": 123,
        "type": "USAGE",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "price_id": "<string>",
      "properties": {},
      "source": "<string>",
      "sub_line_item_id": "<string>",
      "subscription_id": "<string>",
      "subscription_line_item": {
        "billing_period": "MONTHLY",
        "created_at": "<string>",
        "created_by": "<string>",
        "currency": "<string>",
        "customer_id": "<string>",
        "display_name": "<string>",
        "end_date": "<string>",
        "entity_id": "<string>",
        "entity_type": "plan",
        "environment_id": "<string>",
        "id": "<string>",
        "invoice_cadence": "ARREAR",
        "metadata": {},
        "meter_display_name": "<string>",
        "meter_id": "<string>",
        "plan_display_name": "<string>",
        "price": {
          "amount": 123,
          "billing_cadence": "RECURRING",
          "billing_model": "FLAT_FEE",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "conversion_rate": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "<string>",
          "entity_id": "<string>",
          "entity_type": "PLAN",
          "environment_id": "<string>",
          "group_id": "<string>",
          "id": "<string>",
          "invoice_cadence": "ARREAR",
          "lookup_key": "<string>",
          "metadata": {},
          "meter_id": "<string>",
          "parent_price_id": "<string>",
          "price_unit": "<string>",
          "price_unit_amount": 123,
          "price_unit_id": "<string>",
          "price_unit_tiers": [
            {
              "flat_amount": 123,
              "unit_amount": 123,
              "up_to": 123
            }
          ],
          "price_unit_type": "FIAT",
          "start_date": "<string>",
          "status": "published",
          "tenant_id": "<string>",
          "tier_mode": "VOLUME",
          "tiers": [
            {
              "flat_amount": 123,
              "unit_amount": 123,
              "up_to": 123
            }
          ],
          "transform_quantity": {
            "divide_by": 123,
            "round": "<string>"
          },
          "trial_period": 123,
          "type": "USAGE",
          "updated_at": "<string>",
          "updated_by": "<string>"
        },
        "price_id": "<string>",
        "price_type": "USAGE",
        "price_unit": "<string>",
        "price_unit_id": "<string>",
        "quantity": 123,
        "start_date": "<string>",
        "status": "published",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "trial_period": 123,
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "total_cost": 123,
      "total_usage": 123,
      "unit": "<string>",
      "unit_plural": "<string>"
    }
  ],
  "total_cost": 123
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

*/*

Request body

external_customer_id
string
required
end_time
string
expand
string[]

allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon"

feature_ids
string[]
group_by
string[]

allowed values: "source", "feature_id", "properties.<field_name>"

property_filters
object

Property filters to filter the events by the keys in properties field of the event

sources
string[]
start_time
string
window_size
enum<string>
Available options:
MINUTE,
15MIN,
30MIN,
HOUR,
3HOUR,
6HOUR,
12HOUR,
DAY,
WEEK,
MONTH

Response

OK

currency
string
items
object[]
total_cost
number