Data export
Metronome can send your sandbox and production data directly to your data warehouse, giving you the flexibility to build reports and dashboards with your favorite data tools.
Getting started
Exporting data from Metronome is a simple process requiring a one-time setup of your data destination. After the initial export, your data will be updated automatically once a day. To set up your destination, please contact your Growth Representative.
Supported destination types
Metronome supports data export to the most common data warehouses, databases, and object storage providers. We continue to add new providers; if your preferred vendor is not listed below, please contact your Growth Representative.
Data warehouse
- BigQuery
- Clickhouse
- Databricks
- Firebolt
- Redshift
- Snowflake
Database
- Athena
- MySQL
- Postgres
- SingleStore
Object storage
Data availability
What can be exported
- Customer data
- Finalized invoice data
- Credit grants
- Finalized credit grant deductions
- Credit types
- Raw ingested usage events
Export frequency
Data will be exported once per day, which means that some data may be up to 24 hours behind.
Schema
Note: Due to our export methodology, all columns may appear as nullable in your destination schema. The Nullable
column in the table below reflects how your data is stored in Metronome.
customer
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The Metronome ID of the customer | N | text | text | varchar | string | string |
name | The name of the customer | N | text | text | varchar | string | string |
ingest_aliases | The ingest aliases of the customer | N | jsonb | variant | varchar | string | string |
salesforce_account_id | The Salesforce account ID for the customer | Y | text | text | varchar | string | string |
billing_provider_type | The billing provider connected to customer | Y | text | text | varchar | string | string |
billing_provider_customer_id | The billing provider ID of the customer | Y | text | text | varchar | string | string |
environment_type | The Metronome environment | N | text | text | varchar | string | string |
created_at | The timestamp (UTC) of when the customer was created | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
updated_at | The timestamp (UTC) of when the customer was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
archived_at | The timestamp (UTC) of when the customer was archived, if applicable | Y | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
invoice
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The Metronome invoice ID | N | text | text | varchar | string | string |
status | The Metronome invoice status: FINALIZED or VOID (DRAFT invoices are not supported yet) | N | text | text | varchar | string | string |
total | The invoice total | N | decimal | decimal | decimal | numeric | decimal |
credit_type_id | The credit type ID for the invoice | N | text | text | varchar | string | string |
credit_type_name | The name of the credit type associated with the invoice | N | text | text | varchar | string | string |
customer_id | The Metronome ID of the customer | N | text | text | varchar | string | string |
plan_id | The plan ID associated with the invoice | N | text | text | varchar | string | string |
plan_name | The name of the plan associated with the invoice | N | text | text | varchar | string | string |
start_timestamp | Beginning of the usage period that this invoice covers (UTC) | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
end_timestamp | End of the usage period that this invoice covers (UTC) | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
billing_provider_invoice_id | The external invoice ID from the billing provider (e.g., Stripe) | Y | text | text | varchar | string | string |
billing_provider_invoice_created_at | The timestamp (UTC) the external invoice was created by Metronome | Y | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
billing_provider_invoice_external_status | The status of the corresponding external billing provider invoice (e.g., Stripe): DRAFT , FINALIZED , PAID , UNCOLLECTIBLE , VOID , DELETED , or PAYMENT_FAILED | Y | text | text | varchar | string | string |
environment_type | The Metronome environment, SANDBOX or PRODUCTION | N | text | text | varchar | string | string |
updated_at | The timestamp (UTC) this row was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
line_item
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The line item ID | N | text | text | varchar | string | string |
invoice_id | The Metronome invoice ID associated with the line item | N | text | text | varchar | string | string |
credit_type_id | The credit type ID associated with the line item | N | text | text | varchar | string | string |
credit_type_name | The name of the credit type associated with the line item | N | text | text | varchar | string | string |
name | The line item description | N | text | text | varchar | string | string |
quantity | The quantity associated with the line item; this will always be 1 for invoice adjustments | Y | decimal | decimal | decimal | numeric | decimal |
total | The line item total | N | decimal | decimal | decimal | numeric | decimal |
product_id | The product ID associated with the line item; this will always be NULL for invoice adjustments | Y | text | text | varchar | string | string |
group_key | The group key associated with the line item | Y | text | text | varchar | string | string |
group_value | The group value associated with the line item | Y | text | text | varchar | string | string |
updated_at | The timestamp (UTC) of when the line item was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
sub_line_item
Note: Sub line items with a quantity of zero will not be exported.
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The sub line item ID | N | text | text | varchar | string | string |
line_item_id | The line item ID associated with the sub line item | N | text | text | varchar | string | string |
name | The sub line item description | N | text | text | varchar | string | string |
quantity | The quantity associated with the sub line item | Y | decimal | decimal | decimal | numeric | decimal |
subtotal | The subtotal associated with the sub line item | Y | decimal | decimal | decimal | numeric | decimal |
charge_id | The charge ID associated with the sub line item | N | text | text | varchar | string | string |
billable_metric_id | The billable metric ID associated with the sub line item | Y | text | text | varchar | string | string |
billable_metric_name | The name of the billable metric associated with the sub line item | Y | text | text | varchar | string | string |
tiers | Information about the tiers associated with the sub line item, including sub_line_item_id , name , quantity , subtotal , updated_at , price , and starting_at | Y | jsonb | variant | varchar | string | string |
updated_at | The timestamp (UTC) this row was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
credit_grant
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The credit grant ID | N | text | text | varchar | string | string |
customer_id | The customer ID associated with the credit grant | N | text | text | varchar | string | string |
name | The name of the credit grant | N | text | text | varchar | string | string |
invoice_id | The ID of the invoice with the purchase charge for the credit grant, if applicable | Y | text | text | varchar | string | string |
priority | The priority of the credit grant | N | decimal | decimal | decimal | numeric | decimal |
reason | The reason of the credit grant | Y | text | text | varchar | string | string |
amount_granted | The amount of credit granted | N | decimal | decimal | decimal | numeric | decimal |
amount_granted_credit_type_id | The credit type ID for the amount granted | N | text | text | varchar | string | string |
amount_paid | The amount paid for the credit grant | N | decimal | decimal | decimal | numeric | decimal |
amount_paid_credit_type_id | The credit type ID for the amount paid | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
product_ids | The products which the credit grant are applied to; this will be "[]" if the credit grant applies to all products | N | jsonb | variant | varchar | string | string |
environment_type | The Metronome environment, SANDBOX or PRODUCTION | N | text | text | varchar | string | string |
created_at | The timestamp (UTC) of when the credit grant was created | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
updated_at | The timestamp (UTC) of when the credit grant was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
effective_at | The timestamp (UTC) of when the credit grant is effective from | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
expires_at | The timestamp (UTC) of when the credit grant expires at | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
voided_at | The timestamp (UTC) of when the credit grant was voided, if applicable | Y | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
credit_grant_deduction
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The credit grant deduction ID | N | text | text | varchar | string | string |
credit_grant_id | The credit grant ID associated with the credit grant deduction | N | text | text | varchar | string | string |
amount | The amount of credit deducted | N | decimal | decimal | decimal | numeric | decimal |
memo | The memo of the credit grant deduction | N | text | text | varchar | string | string |
invoice_id | The invoice ID associated with the credit grant deduction | N | text | text | varchar | string | string |
effective_at | The timestamp (UTC) of when the credit grant deduction occurred | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
updated_at | The timestamp (UTC) this row was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
credit_type
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
id | The credit type ID | N | text | text | varchar | string | string |
name | The name of the credit type | N | text | text | varchar | string | string |
is_currency | Whether or not the credit type is a currency, TRUE or FALSE | N | boolean | boolean | boolean | bool | boolean |
environment_type | The Metronome environment, SANDBOX or PRODUCTION ; this will always be NULL for currencies | Y | text | text | varchar | string | string |
updated_at | The timestamp (UTC) this row was last updated | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
_metronome_metadata_id | Metronome metadata ID | N | text | text | varchar | string | string |
events
Column name | Description | Nullable? | Postgres data type | Snowflake data type | Redshift data type | BigQuery data type | Databricks data type |
---|
transaction_id | The unique ID of the event | N | text | text | varchar | string | string |
customer_id | The ID of the customer the event applies to | N | text | text | varchar | string | string |
timestamp | The timestamp (UTC) of the event | N | timestamptz | timestamp_tz | timestamptz | timestamp | timestamp |
event_type | The event type | N | text | text | varchar | string | string |
properties | The properties of the event | N | jsonb | variant | varchar | string | string |
environment_type | The Metronome environment, SANDBOX or PRODUCTION | N | text | text | varchar | string | string |
_metronome_metadata_id | Metronome metadata ID | N | text | text | varchar | string | string |