/operations/jobs/results

1 min

GET

https://app.amberflo.io/operations/jobs/results

Responses

200Successful request

operations.query_tool.QueryToolResult.out[]
- objectoperations.query_tool.aoa_meters_failure.AoaMetersFailureResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    aoa_meters_failure
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
- objectoperations.query_tool.commitment_validation.CommitmentValidationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    commitment_validation
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.commitment_validation.CommitmentValidationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      commitment_validation
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
  - commitmentPurchasedPrepaidCardspayment.billing.prepaid_to_product.PrepaidCard.out[]required
    Description
    Prepaid purchased for the commitment.
    - payment.billing.prepaid_to_product.PrepaidCardByPrice.out
      - prepaidUristring
      - paymentStatuspayment.payment.PaymentStatus.out
      - pricenumber
      - worthnumber
      - sourceUristring
      - paymentSystemNamestring
      - paymentIdstring
      - startTimeInSecondsinteger<int64>
      - expirationTimeInSecondsinteger<int64>
      - productInvoicespayment.billing.detailed.EntityProductInvoice.out[]
        invoiceUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
        invoiceAmountnumber
      - transferInvoicespayment.billing.detailed.PrepaidTransferInvoice.out[]
        requestIdstring
        destinationPrepaidUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
      - usedAmountnumber
      - amountLeftnumber
      - cardTypepayment.billing.prepaid_to_product.PrepaidCardType.out
      - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.out
        basePlanCurrencystring
        Example
        USD
        Description
        Currency code in ISO 4217 format.
        paymentCurrencystring
        Example
        USD
        Description
        Currency code in ISO 4217 format.
        exchangeRatenumber
      - prepaidConditionspayment.billing.prepaid_to_product.PrepaidConditions.out
        prepaidConditionsListpayment.billing.prepaid_to_product.PrepaidCondition.out[]
        payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out
        typestring
        Default
        DimensionValueMapPrepaidCondition
        dimensionMapValuemap<string, string>
        payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out
        Max depth limit reached
        payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out
        Max depth limit reached
        prepaidConditionsHistorymap<string, payment.billing.prepaid_to_product.PrepaidCondition.out[]>
      - labelstring
      - commitmentIdstring
      - customPrioritynumber
      - startAtMidCycleboolean
      - orderIdstring
      - orderItemIdstring
      - realTimePricingboolean
      - typestring
        Default
        prepaid_card_by_price
      - purchaseTypepayment.billing.prepaid_to_product.PrepaidPurchaseType.out
      - actualPrepaidChargePricenumber
        Description
        The actual absolute charge amount for the prepaid card, in base currency.
    - payment.billing.prepaid_to_product.PrepaidCardByUsage.out
      - prepaidUristring
      - paymentStatuspayment.payment.PaymentStatus.out
      - pricenumber
      - worthnumber
      - sourceUristring
      - paymentSystemNamestring
      - paymentIdstring
      - startTimeInSecondsinteger<int64>
      - expirationTimeInSecondsinteger<int64>
      - productInvoicespayment.billing.detailed.EntityProductInvoice.out[]
        invoiceUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
        invoiceAmountnumber
      - transferInvoicespayment.billing.detailed.PrepaidTransferInvoice.out[]
        requestIdstring
        destinationPrepaidUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
      - usedAmountnumber
      - amountLeftnumber
      - cardTypepayment.billing.prepaid_to_product.PrepaidCardType.out
      - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.out
        basePlanCurrencystring
        Example
        USD
        Description
        Currency code in ISO 4217 format.
        paymentCurrencystring
        Example
        USD
        Description
        Currency code in ISO 4217 format.
        exchangeRatenumber
      - prepaidConditionspayment.billing.prepaid_to_product.PrepaidConditions.out
        prepaidConditionsListpayment.billing.prepaid_to_product.PrepaidCondition.out[]
        payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out
        Max depth limit reached
        payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out
        Max depth limit reached
        payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out
        Max depth limit reached
        prepaidConditionsHistorymap<string, payment.billing.prepaid_to_product.PrepaidCondition.out[]>
      - labelstring
      - commitmentIdstring
      - customPrioritynumber
      - startAtMidCycleboolean
      - orderIdstring
      - orderItemIdstring
      - realTimePricingboolean
      - typestring
        Default
        prepaid_card_by_usage
      - prepaidUsagenumber
      - prepaidFullPricenumber
      - purchaseTypepayment.billing.prepaid_to_product.PrepaidPurchaseType.out
  - appliedPromotionspayment.pricing.customer.CustomerAppliedPromotion.out[]required
    Description
    List of promotions that were applied during the queried time range.
    - idstring
      Description
      The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).
    - productIdstring
      Description
      Unique product id.
    - customerIdstring
      Description
      Unique customer id.
    - promotionIdstring
      Description
      Unique promotion id to define an applied promotion.
    - appliedTimeInSecondsinteger<int64>
      Description
      Deprecated. When a promotion is in use in a customer pricing plan.
    - addedTimeInSecondsinteger<int64>
      Description
      When a promotion has been added to a pricing plan.
    - removedTimeInSecondsinteger<int64>
      Description
      When a promotion has been removed from a customer pricing plan.
    - relationIdstring
      Description
      The unique ID of the relationship between the customer and promotion.
    - appliedTimeRangepayment.common.TimeRange.out
      Description
      When something is applied and removed with hourly granularity.
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - prioritynumber
      Description
      How we rank promotions of the same type against each other.
    - removalContextmap<string, string>
      Description
      Identifying metadata around who and why a promotion was removed.
    - commitmentIdstring
      Description
      Optional field, populated by internal processes.
    - entityProductInvoicespayment.billing.detailed.EntityProductInvoice.out[]
      Description
      List of invoices that this customer applied promotion was used on.
      - invoiceUristring
      - createdTimeInSecondsinteger<int64>
      - amountnumber
      - invoiceAmountnumber
    - amountLeftInCyclenumber
      Description
      Amount of promotion left in cycle.
    - totalAmountLeftnumber
      Description
      Amount of promotion left in total.
  - dataPointsoperations.query_tool.commitment_validation.CommitmentValidationDataPoint.out[]required
    Description
    List of validation data points for a commitment contract's invoices.
    - invoiceKeypayment.billing.CustomerProductInvoiceKey.outrequired
      Description
      A commitment contract's invoice.
      - accountIdstring
      - customerIdstring
      - productIdstring
      - productPlanIdstring
      - yearinteger<int32>
      - monthinteger<int32>
      - dayinteger<int32>
    - isPricingPlanLockedbooleanrequired
      Description
      Whether the pricing plan is locked.
    - trueUpObligationsWithStatusoperations.query_tool.commitment_validation.TrueUpObligationWithStatus.out[]required
      Description
      List of customer obligations with true-up.
      - trueUpObligationpayment.pricing.commitments.customer.MinTotalPrice.outrequired
        Description
        Customer obligations with true-up.
        typestring
        Default
        min_total_price
        idstring
        obligationTimeRangepayment.common.TimeRange.out
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        totalPriceCommittedinteger<int64>
        usePriceAfterDiscountsboolean
        subtractCommitmentPrepaidboolean
        cycleObligationboolean
      - obligationStatuspayment.pricing.commitments.ObligationStatus.outrequired
        Description
        The obligation status of the true-up customer obligation.
        obligationIdstring
        isCommitmentFullyMetboolean
        violationFoundboolean
        shouldCancelCommitmentboolean
        violationspayment.pricing.commitments.ObligationViolation.out[]
        feeAmountnumber
        violationMeasurenumber
        violatedInvoicespayment.billing.CustomerProductInvoiceKey.out[]
        accountIdstring
        customerIdstring
        productIdstring
        productPlanIdstring
        yearinteger<int32>
        monthinteger<int32>
        dayinteger<int32>
        invoiceToPaypayment.billing.CustomerProductInvoiceKey.out
        accountIdstring
        customerIdstring
        productIdstring
        productPlanIdstring
        yearinteger<int32>
        monthinteger<int32>
        dayinteger<int32>
- objectoperations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    custom_aggregation_timestamps
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      custom_aggregation_timestamps
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
  - dataPointsoperations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsDatapoint.out[]required
    Description
    All the data points found within the time window.
    - accountIdstringrequired
      Description
      The id for an account.
    - meterApiNamestringrequired
      Description
      The id for the meterApi
    - customAggregationSpecIdstringrequired
      Description
      The id of the custom aggregation spec.
    - groupBystring[]required
      Description
      The dimensions of the meter's custom aggregation group
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - hourlyHourlyLastModifiedTimeInSecondsinteger<int64>required
      Description
      The value for the hourly-hourly aggregation.
    - customAggregationLastModifiedTimeInSecondsinteger<int64>required
      Description
      The value for the custom group aggregation.
- objectoperations.query_tool.custom_aggregation_validation.CustomAggregationValidationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    custom_aggregation_validation
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.custom_aggregation_validation.CustomAggregationValidationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      custom_aggregation_validation
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - timeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.outrequired
      Description
      A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series. Notice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning. For example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage. On the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.
    - filtermap<string, string[]>
      Description
      Filter for a list of dimensions to determine a specific Custom Aggregation to validate.
  - comparisonPointsoperations.query_tool.custom_aggregation_validation.CustomAggregationComparisonPoint.out[]required
    Description
    All the data points found within the time window.
    - accountIdstringrequired
      Description
      The id for an account.
    - meterApiNamestringrequired
      Description
      The id for the meterApi
    - customAggregationSpecIdstringrequired
      Description
      The id of the custom aggregation spec.
    - groupBystring[]required
      Description
      The dimensions of the meter's custom aggregation group
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - timeGroupingIntervalValuenumberrequired
      Description
      The value for the summed hourly-hourly or summed daily-hourly aggregation.
    - customAggregationValuenumberrequired
      Description
      The value for the custom aggregation.
    - deltanumberrequired
      Description
      The numeric difference between summed hourly-hourly and custom aggregation.
- objectoperations.query_tool.customer_promotion_explain.CustomerPromotionExplainResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    customer_promotion_explain
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.customer_promotion_explain.CustomerPromotionExplainParams.out
    - typestringrequired
      Description
      The type of query to run
      Default
      customer_promotion_explain
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
  - reportoperations.query_tool.customer_promotion_explain.CustomerPromotionExplainReport.out
    - applicablePromotionsoperations.query_tool.customer_promotion_explain.InvoiceAppliedPromotionExplained.out[]
      - invoiceAppliedPromotionpayment.billing.InvoiceAppliedPromotion.out
        customerAppliedPromotionIdstring
        promotionIdstring
        promotionNamestring
        promotionTypepayment.pricing.promotions.attributes.PromotionType.out
        discountnumber
        hourlyDiscountsmap<string, number>
        promotionAppliedTimeInSecondsinteger<int64>
        maxDiscountPossiblenumber
        canBeUsedForPayAsYouGoboolean
        granularitystring
        entityTdstring
        dimensionsmap<string, string>
        promotionAppliedTimeRangepayment.common.TimeRange.out
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
      - explanationstring
    - addedDuringBillingPeriodoperations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out[]
      - customerAppliedPromotionpayment.pricing.customer.CustomerAppliedPromotion.out
        idstring
        Description
        The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).
        productIdstring
        Description
        Unique product id.
        customerIdstring
        Description
        Unique customer id.
        promotionIdstring
        Description
        Unique promotion id to define an applied promotion.
        appliedTimeInSecondsinteger<int64>
        Description
        Deprecated. When a promotion is in use in a customer pricing plan.
        addedTimeInSecondsinteger<int64>
        Description
        When a promotion has been added to a pricing plan.
        removedTimeInSecondsinteger<int64>
        Description
        When a promotion has been removed from a customer pricing plan.
        relationIdstring
        Description
        The unique ID of the relationship between the customer and promotion.
        appliedTimeRangepayment.common.TimeRange.out
        Description
        When something is applied and removed with hourly granularity.
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        prioritynumber
        Description
        How we rank promotions of the same type against each other.
        removalContextmap<string, string>
        Description
        Identifying metadata around who and why a promotion was removed.
        commitmentIdstring
        Description
        Optional field, populated by internal processes.
        entityProductInvoicespayment.billing.detailed.EntityProductInvoice.out[]
        Description
        List of invoices that this customer applied promotion was used on.
        invoiceUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
        invoiceAmountnumber
        amountLeftInCyclenumber
        Description
        Amount of promotion left in cycle.
        totalAmountLeftnumber
        Description
        Amount of promotion left in total.
      - explanationstring
    - removedDuringBillingPeriodoperations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out[]
      - customerAppliedPromotionpayment.pricing.customer.CustomerAppliedPromotion.out
        idstring
        Description
        The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).
        productIdstring
        Description
        Unique product id.
        customerIdstring
        Description
        Unique customer id.
        promotionIdstring
        Description
        Unique promotion id to define an applied promotion.
        appliedTimeInSecondsinteger<int64>
        Description
        Deprecated. When a promotion is in use in a customer pricing plan.
        addedTimeInSecondsinteger<int64>
        Description
        When a promotion has been added to a pricing plan.
        removedTimeInSecondsinteger<int64>
        Description
        When a promotion has been removed from a customer pricing plan.
        relationIdstring
        Description
        The unique ID of the relationship between the customer and promotion.
        appliedTimeRangepayment.common.TimeRange.out
        Description
        When something is applied and removed with hourly granularity.
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        prioritynumber
        Description
        How we rank promotions of the same type against each other.
        removalContextmap<string, string>
        Description
        Identifying metadata around who and why a promotion was removed.
        commitmentIdstring
        Description
        Optional field, populated by internal processes.
        entityProductInvoicespayment.billing.detailed.EntityProductInvoice.out[]
        Description
        List of invoices that this customer applied promotion was used on.
        invoiceUristring
        createdTimeInSecondsinteger<int64>
        amountnumber
        invoiceAmountnumber
        amountLeftInCyclenumber
        Description
        Amount of promotion left in cycle.
        totalAmountLeftnumber
        Description
        Amount of promotion left in total.
      - explanationstring
- objectoperations.query_tool.data_sync_object_counts.DataSyncObjectCountsResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    data_sync_object_counts
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - dataSyncObjectCountsoperations.DataSyncObjectCounts.out
    Description
    The object counts for the account.
    - objectCountsmap<string, integer>
      Description
      Map of object names to their count totals.
    - computedTimeInSecondsinteger<int64>
      Description
      Time in seconds at which the object counts were computed.
- objectoperations.query_tool.events_filtering_validation.EventsFilteringValidationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    events_filtering_validation
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.events_filtering_validation.EventsFilteringValidationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      events_filtering_validation
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - customerIdstring
      Description
      A customerId to narrow down the search for event filtering rules.
  - dataPointsoperations.query_tool.events_filtering_validation.EventsFilteringDataPoint.out[]required
    Description
    Relevant filtering rules
    - filteringOutRuleingestion.s3_snapshot.filtering_rules.ByPropertyFilteringOutRule.outrequired
      Description
      The filtering rule applied to events
      - typestring
      - idstring
      - ingestionTimeRangeingestion.s3_snapshot.common.TimeRange.out
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
      - meterApiNamestring
      - dimensionValuesMapmap<string, string[]>
    - failedValidationsusage.aggregations.IngestMessage.out[]required
      Description
      List of events that were not filtered out by rule.
      - meterApiNamestring
      - meterValuenumber
      - meterTimeInMillisinteger<int64>
      - dimensionsmap<string, string>
- objectoperations.query_tool.QueryToolExceptionResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    exception
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
- objectoperations.query_tool.file_search_verification.FileSearchResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    file_search
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.file_search_verification.FileSearchMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      file_search
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - timeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.out
      Description
      A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series. Notice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning. For example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage. On the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.
    - dimensionsmap<string, string>
      Description
      Applicable dimensions for the meter. Used to speed up search
    - searchTypeoperations.query_tool.file_search_verification.SearchType.outrequired
      Description
      Used to determine which files to search. Use 'aggregate', 'raw' or 'ingest'
    - timeNormalizedboolean
      Description
      Optional param; if set, is used to determine which timeNormalized files to search. Applicable only to 'raw' valueType
    - valuenumberrequired
      Description
      The value to search for
    - rangenumber
      Description
      A range to search for the value. For example, if looking for a value of '80' and a range of '5' will search for occurrences of values in [75,85].If not set, will only look for the specific value '80'.
  - exactAggregateMatchesusage.MeterAggregation.out[]required
    Description
    List of the exact matches found for an aggregate search
    - metadatausage.MeterAggregationMetadata.out
      - accountstring
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationusage.AggregationType.out
        Description
        Aggregation function. If not specified, the default is obtained from the associated meter definition.
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - filtermap<string, string[]>
        Description
        `where` clause for the usage query. Each entry is a dimension and a list of values to filter for.", Valid filters are: - `customerId` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters). - `tags:<tagId>` Different filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator. Tags can be specified in filters using the prefix `tags:`. For example, 1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev` 2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.
      - groupBystring[]
        Description
        Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole. Valid values are: - `customerId` - `customerName` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters).
      - takeusage.MeterAggregationMetadata.Take.out
        limitinteger<int32>required
        isAscendingboolean
      - timeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.out
        Description
        A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series. Notice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning. For example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage. On the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.
      - valuesTimeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.out
      - rescaleFunctioncom.amberflo.service.common.aggregation.RescaleFunction.out
        functioncom.amberflo.service.common.aggregation.RescaleFunctionType.out
        coefficientnumber
    - clientMetersusage.MeterAggregation.MeterAggregationGroup.out[]
      - groupusage.MeterAggregation.GroupInfo.out
        groupInfomap<string, string>
      - groupValuenumber
      - valuesusage.MeterAggregation.AggregationValue.out[]
        valuenumber
        secondsSinceEpochUtcinteger<int64>
  - rangedAggregateMatchesusage.MeterAggregation.out[]required
    Description
    List of the matches found, in range, for an aggregate search
    - metadatausage.MeterAggregationMetadata.out
      - accountstring
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationusage.AggregationType.out
        Description
        Aggregation function. If not specified, the default is obtained from the associated meter definition.
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - filtermap<string, string[]>
        Description
        `where` clause for the usage query. Each entry is a dimension and a list of values to filter for.", Valid filters are: - `customerId` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters). - `tags:<tagId>` Different filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator. Tags can be specified in filters using the prefix `tags:`. For example, 1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev` 2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.
      - groupBystring[]
        Description
        Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole. Valid values are: - `customerId` - `customerName` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters).
      - takeusage.MeterAggregationMetadata.Take.out
        limitinteger<int32>required
        isAscendingboolean
      - timeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.out
        Description
        A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series. Notice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning. For example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage. On the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.
      - valuesTimeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.out
      - rescaleFunctioncom.amberflo.service.common.aggregation.RescaleFunction.out
        functioncom.amberflo.service.common.aggregation.RescaleFunctionType.out
        coefficientnumber
    - clientMetersusage.MeterAggregation.MeterAggregationGroup.out[]
      - groupusage.MeterAggregation.GroupInfo.out
        groupInfomap<string, string>
      - groupValuenumber
      - valuesusage.MeterAggregation.AggregationValue.out[]
        valuenumber
        secondsSinceEpochUtcinteger<int64>
  - nonExistentFilesstring[]required
    Description
    Any files that did not exist in the search, applicable to an aggregate search
  - exactRawMatchesingestion.s3_snapshot.IngestMessage.out[]required
    Description
    List of the exact matches found for a raw or ingest search
    - meterApiNamestring
    - meterValuenumber
    - meterTimeInMillisinteger<int64>
    - sourcePathstring
    - dimensionsmap<string, string>
  - rangedRawMatchesingestion.s3_snapshot.IngestMessage.out[]required
    Description
    List of the matches found, in range, for a raw or ingest search
    - meterApiNamestring
    - meterValuenumber
    - meterTimeInMillisinteger<int64>
    - sourcePathstring
    - dimensionsmap<string, string>
  - exactRawParquetMatchesingestion.IngestMessage.out[]required
    Description
    List of the exact matches found for a raw or ingest search
    - uniqueIdstring
      Description
      Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.
    - meterApiNamestring
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters). Required if `values` is not set or empty.
    - meterValuenumber
      Description
      Meter value to be ingested. This will be used for aggregation. Required if `values` is not set or empty.
    - meterTimeInMillisinteger<int64>required
      Description
      Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - customerIdstringrequired
      Description
      `customerId` as defined in [Customer API](ref:post_customers).
    - dimensionsmap<string, string>
      Description
      Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).
    - variantsingestion.IngestMessage.Variant.out[]
      Description
      When set, each entry will be merged with the main fields to form the resulting ingest messages. This is a more flexible alternative to the `values` field. May not be used together with the `values` field.
      - meterApiNamestring
        Description
        See the main `meterApiName` field.
      - meterValuenumber
        Description
        See the main `meterValue` field.
      - dimensionsmap<string, string>
        Description
        See the main `dimension` field.
    - valuesmap<string, number>
      Description
      Map of `meterApiName` to `meterValue`. Use this field instead of the `meterApiName` and `meterValue` fields if you want to send multiple values in a single ingest message May only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.
  - rangedRawParquetMatchesingestion.IngestMessage.out[]required
    Description
    List of the matches found, in range, for a raw or ingest search
    - uniqueIdstring
      Description
      Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.
    - meterApiNamestring
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters). Required if `values` is not set or empty.
    - meterValuenumber
      Description
      Meter value to be ingested. This will be used for aggregation. Required if `values` is not set or empty.
    - meterTimeInMillisinteger<int64>required
      Description
      Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - customerIdstringrequired
      Description
      `customerId` as defined in [Customer API](ref:post_customers).
    - dimensionsmap<string, string>
      Description
      Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).
    - variantsingestion.IngestMessage.Variant.out[]
      Description
      When set, each entry will be merged with the main fields to form the resulting ingest messages. This is a more flexible alternative to the `values` field. May not be used together with the `values` field.
      - meterApiNamestring
        Description
        See the main `meterApiName` field.
      - meterValuenumber
        Description
        See the main `meterValue` field.
      - dimensionsmap<string, string>
        Description
        See the main `dimension` field.
    - valuesmap<string, number>
      Description
      Map of `meterApiName` to `meterValue`. Use this field instead of the `meterApiName` and `meterValue` fields if you want to send multiple values in a single ingest message May only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.
- objectoperations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    hourly_hourly_to_daily_hourly_validation
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      hourly_hourly_to_daily_hourly_validation
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
  - dataPointsoperations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyComparisonDataPoint.out[]required
    Description
    All the data points found within the time window.
    - accountIdstringrequired
      Description
      The id for an account.
    - meterApiNamestringrequired
      Description
      The id for the meterApi
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - hourlyHourlyValuenumberrequired
      Description
      The value for the hourly-hourly aggregation.
    - dailyHourlyValuenumberrequired
      Description
      The value for the dail-hourly aggregation.
    - deltanumberrequired
      Description
      The numeric difference between hourly-hourly and daily-hourly.
- objectoperations.query_tool.invoice_explain.InvoiceExplainResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    invoice_explain
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.invoice_explain.InvoiceExplainParams.out
    - typestringrequired
      Description
      The type of query to run
      Default
      invoice_explain
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
  - reportoperations.query_tool.invoice_explain.InvoiceExplainReport.out
    - validInvoiceUsageboolean
    - mapMeterNameToFailedInvoiceUsageToUsagePointmap<string, operations.query_tool.invoice_usage_verification.InvoiceUsageComparisonPoint.out[]>
    - validPrepaidCreditsboolean
    - prepaidCreditsComparisonPointoperations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.out
      - usedPriceCreditsOnInvoicenumberrequired
        Description
        The number of used price credits that is stated in our invoice.
      - priceCreditsRemainingOnInvoicenumberrequired
        Description
        The number of available price credits that can be used toward the customers current invoice.
      - usedUsageCreditsOnInvoicenumberrequired
        Description
        The number of used usage credits that is stated in our invoice.
      - usageCreditsRemainingOnInvoicenumberrequired
        Description
        The number of available usage credits that can be used toward the customers current invoice.
      - totalCreditsOnInvoicenumberrequired
        Description
        The total (price & usage) credit price amount in our invoice.
      - usedPriceCreditsInWalletnumberrequired
        Description
        The number of used price credits seen in a customer's wallet.
      - priceCreditsRemainingInWalletnumberrequired
        Description
        The number of available price credits seen in a customer's wallet.
      - usedUsageCreditsInWalletnumberrequired
        Description
        The number of used usage credits seen in a customer's wallet.
      - usageCreditsRemainingInWalletnumberrequired
        Description
        The number of available usage credits seen in a customer's wallet.
      - totalCreditsInWalletnumberrequired
        Description
        The total (price & usage) credit price amount in a customer's wallet.
    - validJournalboolean
    - noLateArrivalsboolean
    - lateArrivalEventsmap<string, integer>
    - planpayment.pricing.ProductPlan.out
      - idstring
      - productIdstring
      - productItemPriceIdsMapmap<string, string>
      - billingPeriodpayment.pricing.BillingPeriod.out
        intervalpayment.pricing.BillingPeriodInterval.out
        intervalsCountinteger<int32>
      - planLevelFreeTiernumber
      - invoiceBasedFeeIdsstring[]
      - planMinimumPaymentnumber
        Description
        A minimum payment for the entire plan.
      - minimumPaymentGranularitypayment.pricing.price.UsageGranularity.out
        Description
        Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
      - productPlanNamestring
      - descriptionstring
      - lastUpdateTimeInMillisinteger<int64>
      - feeMapmap<string, payment.pricing.ProductPlanFee.out>
      - entitlementspayment.pricing.Entitlements.Entitlement.out[]
        idstringrequired
        Description
        Id for the Entitlement.
        labelstring
        Description
        Label for the Entitlement.
        apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
      - lockingStatuscom.amberflo.service.common.LockingStatus.out
      - isDefaultboolean
      - successorPlanIdstring
      - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
      - typestring
      - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.out
        Description
        Rules for the prepaid
        planFixedFeeIdsToPrepaystring[]
        planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
        productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        productItemIdstring
        Description
        Product item id that is associated with amount of prepaid.
        prepaidAmountnumber
        Description
        Prepaid amount that is associated with the object.
        walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
        productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
      - planGeneratorpayment.pricing.plans.generators.PlanGenerator.out
        Description
        The template of the plan generator
        payment.pricing.plans.generators.CustomPlanGenerator.out
        typestring
        Description
        Type of template, automatically populated.
        Default
        custom_pricing_plan
        idstringrequired
        Description
        Id associated with the plan.
        billingPeriodpayment.pricing.BillingPeriod.outrequired
        Description
        Billing period of the plan: how often an invoice is generated.
        intervalpayment.pricing.BillingPeriodInterval.out
        Max depth limit reached
        intervalsCountinteger<int32>
        planLevelFreeTiernumber
        Description
        Amount that user can use for free without paying on a plan level.
        invoiceBasedFeeIdsstring[]
        Description
        A set of fee ids that can calculate an invoice's cost in a custom way.
        planMinimumPaymentnumber
        Description
        A minimum payment for the entire plan.
        minimumPaymentGranularitypayment.pricing.price.UsageGranularity.out
        Description
        Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
        planNamestringrequired
        Description
        Name of the plan. Useful for displaying to users.
        descriptionstring
        Description
        Description of the plan. Useful for displaying to users.
        feeMapmap<string, payment.pricing.ProductPlanFee.out>
        Description
        Fee Id to fee that maps to product plan fee.
        entitlementspayment.pricing.Entitlements.Entitlement.out[]
        Description
        A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
        idstringrequired
        Description
        Id for the Entitlement.
        labelstring
        Description
        Label for the Entitlement.
        apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the plan can be modified or not.
        isDefaultboolean
        Description
        Indicates if the plan is the default plan for users.
        successorPlanIdstring
        Description
        Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
        transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
        Description
        Successor plan transition: whether to wait for end of billing cycle or not.
        prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.out
        Description
        Rules for the prepaid
        planFixedFeeIdsToPrepaystring[]
        planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
        productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        Max depth limit reached
        walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
        productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
        planCurrencystring
        Example
        USD
        Description
        The customized currency for the plan in ISO 4217 format.
        priceGeneratorspayment.pricing.price.generators.PriceGenerator.out[]required
        Description
        List of price generators to use in the plan. Can be any price generator.
        payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.FlatRatePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.TieredSeatBasedGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
        invoiceBasedFeespayment.pricing.invoice_based_fees.InvoiceBasedFee.out[]
        Description
        The service fees for the invoice.
        payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out
        Max depth limit reached
        payment.pricing.plans.generators.FlatRatePlanGenerator.out
        idstringrequired
        Description
        Id associated with the plan.
        billingPeriodpayment.pricing.BillingPeriod.outrequired
        Description
        Billing period of the plan: how often an invoice is generated.
        Max depth limit reached
        planNamestringrequired
        Description
        Name of the plan. Useful for displaying to users.
        priceGeneratorspayment.pricing.price.generators.FlatRatePriceGenerator.out[]required
        Description
        List of price generators to use in the plan. Must be strictly flat rate.
        Max depth limit reached
        descriptionstring
        Description
        Description of the plan. Useful for displaying to users.
        invoiceBasedFeeIdsstring[]
        Description
        A set of fee ids that can calculate an invoice's cost in a custom way.
        isDefaultboolean
        Description
        Indicates if the plan is the default plan for users.
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the plan can be modified or not.
        Max depth limit reached
        planLevelFreeTiernumber
        Description
        Amount that user can use for free without paying on a plan level.
        successorPlanIdstring
        Description
        Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
        transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
        Description
        Successor plan transition: whether to wait for end of billing cycle or not.
        Max depth limit reached
        entitlementspayment.pricing.Entitlements.Entitlement.out[]
        Description
        A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
        Max depth limit reached
        typestring
        Description
        Type of template, automatically populated.
        Default
        flat_rate
        payment.pricing.plans.generators.PayAndGoPlanGenerator.out
        Max depth limit reached
        payment.pricing.plans.generators.UsageBasedPlanGenerator.out
        Max depth limit reached
        payment.pricing.plans.generators.SeatBasedPlanGenerator.out
        Max depth limit reached
        payment.pricing.plans.generators.SubscriptionPlanGenerator.out
        Max depth limit reached
      - planCurrencystring
        Example
        USD
        Description
        The customized currency for the plan in ISO 4217 format.
      - realTimePricingboolean
    - billsByProductItemmap<string, payment.billing.ItemVariantBill.out>
    - totalProductPlanFeesnumber
- objectoperations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    invoice_late_arrivals_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationParams.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      invoice_late_arrivals_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
    - filtermap<string, string[]>
      Description
      Filter for which meter to filter usage on.
  - trueLateArrivalsmap<string, integer>
    Description
    The true late arrival events
- objectoperations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    invoice_usage_costs_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      invoice_usage_costs_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
    - sourceoperations.SourceType.outrequired
      Description
      Our source of truth for certain meter types.
  - dataPointsoperations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsComparisonPoint.out[]required
    Description
    All the data points found within the time window.
    - meterApiNamestringrequired
      Description
      The name of the billable meter.
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - indexedValuenumberrequired
      Description
      The value that is aggregated or seen in Amberflo's system.
    - invoiceValuenumberrequired
      Description
      The meter values used to compute a customer's invoice.
    - deltanumberrequired
      Description
      The numeric difference our usage cost and the source at a specific time window.
- objectoperations.query_tool.invoice_usage_verification.InvoiceUsageVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    invoice_usage_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      invoice_usage_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
    - filtermap<string, string[]>
      Description
      Filter for which meter to filter usage on.
    - sourceoperations.SourceType.out
      Description
      Our source of truth for certain meter types.
  - dataPointsmap<string, operations.query_tool.invoice_usage_verification.InvoiceUsageComparisonPoint.out[]>required
    Description
    All the data points found within the time window.
- objectoperations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    item_invoice_usage_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      invoice_usage_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
    - filtermap<string, string[]>
      Description
      Filter for which meter to filter usage on.
    - sourceoperations.SourceType.out
      Description
      Our source of truth for certain meter types.
  - dataPointsmap<string, operations.query_tool.invoice_usage_verification.InvoiceUsageComparisonPoint.out[]>required
    Description
    All the data points found within the time window.
- objectoperations.query_tool.locked_invoice_verification.LockedInvoiceVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    locked_invoice_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.locked_invoice_verification.LockedInvoiceVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      locked_invoice_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
    - sourceoperations.SourceType.outrequired
      Description
      Our source of truth for certain meter types.
  - invoiceStatuspayment.billing.InvoiceStatus.out
- objectoperations.query_tool.long_lasting_explain.LongLastingExplainResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    long_lasting_explain
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.long_lasting_explain.LongLastingExplainParams.out
    - typestringrequired
      Description
      The type of query to run
      Default
      long_lasting_explain
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - customerIdstringrequired
      Description
      A specific customerId. Used to grab metrics pertaining to their usage.
  - resourceHistoriesoperations.query_tool.long_lasting_explain.LongLastingExplainResourceHistory.out[]
    - resourceIdstring
    - mostRecentEventBeforeTimeWindowaggregation_explain.UsageEventInfo.out
      - eventTimeInMillisinteger<int64>
      - eventTimestring
      - ratenumber
      - usagenumber
      - durationInSecondsinteger<int64>
    - usageRateAtTimeWindowStartnumber
    - eventsDuringTimeWindowaggregation_explain.UsageEventInfo.out[]
      - eventTimeInMillisinteger<int64>
      - eventTimestring
      - ratenumber
      - usagenumber
      - durationInSecondsinteger<int64>
    - usageRateAtTimeWindowEndnumber
    - usagenumber
    - maxUsageRatenumber
  - reportSummaryoperations.query_tool.long_lasting_explain.LongLastingExplainReportSummary.out
    - configuredTimeoutMinutesinteger<int32>
    - totalAmountOfResourcesStartedinteger<int64>
    - totalUsageRateStartednumber
    - totalAmountOfResourcesEndedinteger<int64>
    - totalUsageRateEndednumber
    - totalAmountOfImplicitResourcesinteger<int64>
    - totalImplicitUsageRatenumber
    - totalUsagenumber
    - totalMaxUsageRatenumber
- objectoperations.query_tool.long_lasting_verification.LongLastingVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    long_lasting_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.long_lasting_verification.LongLastingVerificationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      long_lasting_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - sourceoperations.SourceType.out
      Description
      Our source of truth for certain meter types.
    - filtermap<string, string[]>
      Description
      `where` clause for the usage query. Each entry is a dimension and a list of values to filter for.", Valid filters are: - `customerId` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters). - `tags:<tagId>` Different filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator. Tags can be specified in filters using the prefix `tags:`. For example, 1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev` 2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.
  - dataPointsoperations.query_tool.long_lasting_verification.LongLastingComparisonDataPoint.out[]required
    Description
    All the data points found within the time window.
    - groupIdstringrequired
      Description
      The id for an aggregation group.
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - usageValuenumberrequired
      Description
      The value that is aggregated or seen in Amberflo's system.
    - sourceValuenumberrequired
      Description
      The raw events aggregated before entering our pipeline.
    - deltanumberrequired
      Description
      The numeric difference between our usage and source at a specific time window.
- objectoperations.query_tool.marketplace_payments.MarketplacePaymentsResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    marketplace_payments
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.marketplace_payments.MarketplacePaymentsMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      marketplace_payments
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - showIntentsbooleanrequired
      Description
      Choose whether to show the intents that fall within the provided timerange
    - sourceTypeoperations.SourceType.outrequired
      Description
      Our source of truth for certain meter types.
  - intentspayment.billing.MarketplaceBilledInvoiceIntent.out[]required
    Description
    The list of intents for the provided timerange.
    - invoiceUristring
    - timestampjava.time.Instant.out
      - secondsinteger<int64>
      - nanosinteger<int32>
    - invoiceTotalCurrencyFractioninteger<int64>
    - billedCurrencyFractioninteger<int32>
    - submittedboolean
    - meteringRecordIdstring
    - expiredboolean
- objectoperations.query_tool.meter_event_dedupe.MeterEventDedupeResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    meter_event_dedupe
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - dataPointsoperations.query_tool.meter_event_dedupe.MeterDedupeComparisonPoint.out[]required
    Description
    All the data points found within the time window.
    - beforeValuenumberrequired
      Description
      The raw events ingested before entering our pipeline.
    - afterValuenumberrequired
      Description
      The number of events following deduplication.
    - s3Urlstringrequired
      Description
      The file url to check.
    - commentstringrequired
      Description
      Additional information addressing anomalous behavior of this comparison point.
- objectoperations.query_tool.platform_jobs_api.PlatformJobsApiResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    platform_jobs_api
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.platform_jobs_api.PlatformJobsApiParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      platform_jobs_api
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - jobIdstringrequired
      Description
      A unique identifier associated with each job.
  - joboperations.query_tool.platform_jobs_api.PlatformJob.out
    Description
    Job from the Jobs Metadata API
    - schedulerContextoperations.query_tool.platform_jobs_api.PlatformJob.SchedulerContext.out
      Description
      Context providing details about scheduler's timings and iterations
      - previousTimeinteger<int64>
        Description
        The point in time when the last job execution finished.
      - nextTimeinteger<int64>
        Description
        The point in time when the next job execution is scheduled.
      - iterationsinteger<int64>
        Description
        The total number of iterations this job has executed.
    - minimizeFreshboolean
      Description
      Flag indicating whether to minimize the freshness of the data fetched
    - createTimeinteger<int64>
      Description
      The timestamp of when the job was created
    - aggregationBucketstring
      Description
      The frequency at which the job data should be aggregated
    - jobNamestring
      Description
      Name of the job
    - s3Urlstring
      Description
      URL of storage location for the job data
    - enabledboolean
      Description
      Flag indicating whether the job is enabled or not
    - cronstring
      Description
      Cron expression representing the schedule of the job
    - rangestring
      Description
      String representing when the data should be fetched from
    - updateTimeinteger<int64>
      Description
      The timestamp of the last update to the job
    - descriptionstring
      Description
      Short description of the job
    - idstring
      Description
      A unique identifier for the job
    - groupBystring[]
      Description
      A list of dimensions to group the data by
    - meterApiNamesstring[]
      Description
      A list of meter API names
  - accountEventsoperations.query_tool.platform_jobs_api.PlatformJobAccountEvent.out[]
    Description
    Job execution account events for the job
    - idstringrequired
      Description
      Unique ID for the event
    - eventTypestringrequired
      Description
      Type or category of the event
    - eventTimestringrequired
      Description
      Timestamp of when the event occurred
    - detailsoperations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Details.outrequired
      Description
      Details of the Job that generated the event
      - jobIdstringrequired
        Description
        Job ID
      - queryoperations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Query.out[]required
        Description
        Query List
        groupBystring[]required
        Description
        List of dimensions that the query aggregates or groups by
        timeRangecommon.TimeRange.outrequired
        Description
        Time range for the query
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
        aggregationstringrequired
        Description
        Type of aggregation performed by the query, like SUM, AVG, etc.
        meterApiNamestringrequired
        Description
        The meter API name for the query
      - messagestringrequired
        Description
        Message describing the result or status of the job
      - ranTimeinteger<int64>required
        Description
        Execution time of the job in milliseconds
      - errorstringrequired
        Description
        Error message
- objectoperations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    prepaid_credits_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      prepaid_credits_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
    - invoiceUristringrequired
      Description
      The invoiceUri in question
  - totalUtilizationoperations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.outrequired
    Description
    All the data points found within the time window.
    - usedPriceCreditsOnInvoicenumberrequired
      Description
      The number of used price credits that is stated in our invoice.
    - priceCreditsRemainingOnInvoicenumberrequired
      Description
      The number of available price credits that can be used toward the customers current invoice.
    - usedUsageCreditsOnInvoicenumberrequired
      Description
      The number of used usage credits that is stated in our invoice.
    - usageCreditsRemainingOnInvoicenumberrequired
      Description
      The number of available usage credits that can be used toward the customers current invoice.
    - totalCreditsOnInvoicenumberrequired
      Description
      The total (price & usage) credit price amount in our invoice.
    - usedPriceCreditsInWalletnumberrequired
      Description
      The number of used price credits seen in a customer's wallet.
    - priceCreditsRemainingInWalletnumberrequired
      Description
      The number of available price credits seen in a customer's wallet.
    - usedUsageCreditsInWalletnumberrequired
      Description
      The number of used usage credits seen in a customer's wallet.
    - usageCreditsRemainingInWalletnumberrequired
      Description
      The number of available usage credits seen in a customer's wallet.
    - totalCreditsInWalletnumberrequired
      Description
      The total (price & usage) credit price amount in a customer's wallet.
  - utilByCardmap<string, payment.pricing.customer.PrepaidUtilization.out>required
    Description
    Break down of util by each prepaid card.
  - invoiceUristringrequired
    Description
    S3 path to find the current invoice we are verifying.
- objectoperations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    rest_api_latency
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
- objectoperations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    s3_bucket_ingestion_failures
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - failureCountinteger<int32>required
    Description
    Total number of S3 ingestion failure records detected
  - s3Urisstring[]
    Description
    List of URIs pointing to the specific S3 objects related to ingestion failures for detailed investigation.
  - errorFrequencyMapmap<string, integer>required
    Description
    Map detailing the frequency of each specific ingestion failure error.
- objectoperations.query_tool.s3_timestamps_verification.S3TimestampsVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    s3_timestamps_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.s3_timestamps_verification.S3TimestampsVerificationParams.outrequired
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      s3_timestamps_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
  - dataPointsoperations.query_tool.s3_timestamps_verification.S3TimestampsVerificationDatapoint.out[]required
    Description
    All the data points found within the time window.
    - accountIdstringrequired
      Description
      The id for an account.
    - meterApiNamestringrequired
      Description
      The id for the meterApi
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - hourlyHourlyLastModifiedTimeInSecondsinteger<int64>required
      Description
      The value for the hourly-hourly aggregation.
    - dailyHourlyLastModifiedTimeInSecondsinteger<int64>required
      Description
      The value for the dail-hourly aggregation.
- objectoperations.query_tool.data_salesforce_data_sync.SalesforceDataSyncResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    salesforce_data_sync
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.data_salesforce_data_sync.SalesforceDataSyncParams.out
    Description
    Information pertaining to the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      salesforce_data_sync
  - comparisonMapmap<string, object>
    Description
    Map of comparative analyses between Salesforce and Amberflo object counts.
- objectoperations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    squashable_sum_meter_athena
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - dataPointsoperations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaPoint.out[]required
    Description
    All the data points found within the time window.
    - athenaValuenumberrequired
      Description
      Events from Athena.
    - usageValuenumberrequired
      Description
      Events from Usage.
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
    - deltanumberrequired
      Description
      The numeric difference between our usage and athena at a specific time window.
- objectoperations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    stripe_flat_fee_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.outrequired
    Description
    Information pertaining to the original request.
    - typestringrequired
      Description
      The type of query to run
      Default
      stripe_payment_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
  - accountStripeIdstringrequired
    Description
    An account's stripeId. If a customer can pay with stripe, an account should receive through stripe.
  - paymentIntentsoperations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.outrequired
    Description
    Each individual customer's invoice and payment status during a time period.
    - customerIdstringrequired
      Description
      An account's customer.
    - stripeIdstringrequired
      Description
      An customer's stripeId.
    - invoiceUristringrequired
      Description
      The current CustomerProductInvoiceKey uri.
    - invoiceStatuspayment.billing.InvoiceStatus.outrequired
      Description
      Our stored InvoiceStatus.
    - paymentStatuspayment.payment.PaymentStatus.outrequired
      Description
      Our stored PaymentStatus.
    - statusoperations.query_tool.stripe_payment_verification.StripeVerificationStatus.outrequired
      Description
      Our determined outcome based on whether a payment has been made and if it was successful.
    - stripePaymentIntentpayment.stripe.StripePaymentIntent.outrequired
      Description
      Latest information regarding a customer's stripe payment.
      - idstring
      - ownerstring
      - descriptionstring
      - amountnumber
      - customerIdstring
      - stripeCustomerIdstring
      - stripePaymentIdstring
      - stripePaymentStatusstring
      - internalStatusstring
      - createdTimeInSecondsInStripeinteger<int64>
      - createdTimeInMillisinteger<int64>
      - lastUpdateTimeInMillisinteger<int64>
      - currencystring
      - paymentMethodIdstring
      - stripeErrorMessagestring
- objectoperations.query_tool.stripe_payment_verification.StripePaymentVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    stripe_payment_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.outrequired
    Description
    Information pertaining to the original request.
    - typestringrequired
      Description
      The type of query to run
      Default
      stripe_payment_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - customerIdstringrequired
      Description
      An account's customer
  - accountStripeIdstringrequired
    Description
    An account's stripeId. If a customer can pay with stripe, an account should receive through stripe.
  - paymentIntentsoperations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.outrequired
    Description
    Each individual customer's invoice and payment status during a time period.
    - customerIdstringrequired
      Description
      An account's customer.
    - stripeIdstringrequired
      Description
      An customer's stripeId.
    - invoiceUristringrequired
      Description
      The current CustomerProductInvoiceKey uri.
    - invoiceStatuspayment.billing.InvoiceStatus.outrequired
      Description
      Our stored InvoiceStatus.
    - paymentStatuspayment.payment.PaymentStatus.outrequired
      Description
      Our stored PaymentStatus.
    - statusoperations.query_tool.stripe_payment_verification.StripeVerificationStatus.outrequired
      Description
      Our determined outcome based on whether a payment has been made and if it was successful.
    - stripePaymentIntentpayment.stripe.StripePaymentIntent.outrequired
      Description
      Latest information regarding a customer's stripe payment.
      - idstring
      - ownerstring
      - descriptionstring
      - amountnumber
      - customerIdstring
      - stripeCustomerIdstring
      - stripePaymentIdstring
      - stripePaymentStatusstring
      - internalStatusstring
      - createdTimeInSecondsInStripeinteger<int64>
      - createdTimeInMillisinteger<int64>
      - lastUpdateTimeInMillisinteger<int64>
      - currencystring
      - paymentMethodIdstring
      - stripeErrorMessagestring
- objectoperations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    ultra_frequency_usage_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      ultra_frequency_usage_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - MAX_INTERVAL_IN_SECONDSinteger<int64>
    - MIN_ACCEPTABLE_HOURS_BEFORE_NOWinteger<int32>
    - sourceoperations.SourceType.outrequired
      Description
      Our source of truth for certain meter types.
  - dataPointsoperations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageComparisonPoint.out[]required
    Description
    All the data points found within the time window.
    - meterApiNamestringrequired
      Description
      The name of the billable meter.
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - usageValuenumberrequired
      Description
      The usage value derived from S3 full aggregations (after going through UF pipeline).
    - sourceValuenumberrequired
      Description
      The usage value derived from S3 raw events (before going through UF pipeline).
    - deltanumberrequired
      Description
      The numeric difference between our usage and source for a specific time window.
- objectoperations.query_tool.usage_monitoring.UsageMonitoringResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    usage_monitoring
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.usage_monitoring.UsageMonitoringParams.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      usage_monitoring
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
- objectoperations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    usage_sqs_statuses
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
- objectoperations.query_tool.usage_verification.UsageVerificationResult.out
  - typestring
    Description
    The type of QueryToolResult for de-serialization.
    Default
    usage_verification
  - scriptParamsoperations.jobs.Job.out[]required
    Description
    Currently unneeded for Custom Aggregations.
    - operations.jobs.scripts.RunBillingJobParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        billing_app
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        data_sync_object_counts
      - accountIdstring
        Description
        The account ID to get object counts for
    - operations.jobs.scripts.RunCustomAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_custom_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
        endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - customAggregationSpecIdstringrequired
        Description
        The ID of the custom aggregation spec
    - operations.jobs.scripts.RunDailyHourlyAggregationParams.out
      - typestringrequired
        Description
        The type of query to run
        Default
        run_daily_hourly_aggregation
      - timeRangecommon.TimeRange.outrequired
        Description
        Time period for which to compute the usage.
        Max depth limit reached
      - accountIdstring
        Description
        `accountId` specific for jobs.
      - meterApiNamestringrequired
        Description
        `meterApiName` as defined in [Meter API](ref:post_meters).
      - aggregationTypecom.amberflo.service.common.aggregation.AggregationType.out
        Description
        The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter
        Max depth limit reached
    - operations.jobs.scripts.RunHourlyAggregationParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunIngestSnapshotParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunItemInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunLockedProductInvoiceParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunMarketplacePaymentsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageCostsParams.out
      - Max depth limit reached
    - operations.jobs.scripts.RunUsageJobParams.out
      - Max depth limit reached
  - statusoperations.VerificationStatus.outrequired
    Description
    Overall health of the pipeline during a time window
  - summarystring[]required
    Description
    A human readable summary of the report.
  - instructionsstring[]required
    Description
    After a verification is run, we want to determine the next actions an operator should take.
  - metadataoperations.query_tool.usage_verification.UsageVerificationMetadata.outrequired
    Description
    Information pertaining the original request
    - typestringrequired
      Description
      The type of query to run
      Default
      usage_verification
    - timeRangecommon.TimeRange.outrequired
      Description
      Time period for which to compute the usage.
      - startTimeInSecondsinteger<int64>required
        Description
        Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).
      - endTimeInSecondsinteger<int64>
        Description
        End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to "now".
    - accountIdstring
      Description
      `accountId` specific for jobs.
    - meterApiNamestringrequired
      Description
      `meterApiName` as defined in [Meter API](ref:post_meters).
    - timeGroupingIntervalcom.amberflo.service.common.aggregation.AggregationInterval.outrequired
      Description
      A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series. Notice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning. For example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage. On the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.
    - filtermap<string, string[]>
      Description
      `where` clause for the usage query. Each entry is a dimension and a list of values to filter for.", Valid filters are: - `customerId` - Any dimension defined in for the meter, see the [Meter API](ref:post_meters). - `tags:<tagId>` Different filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator. Tags can be specified in filters using the prefix `tags:`. For example, 1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev` 2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.
    - sourceoperations.SourceType.outrequired
      Description
      Our source of truth for certain meter types.
  - dataPointsoperations.query_tool.usage_verification.UsageComparisonPoint.out[]required
    Description
    All the data points found within the time window.
    - timeInSecondsinteger<int64>required
      Description
      The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - usageValuenumberrequired
      Description
      The value that is aggregated or seen in Amberflo's system.
    - sourceValuenumberrequired
      Description
      The raw events aggregated before entering our pipeline.
    - deltanumberrequired
      Description
      The numeric difference between our usage and source at a specific time window.
    - commentstringrequired
      Description
      Additional information addressing anomalous behavior of this comparison point.

curl

curl --request GET \
     --url https://app.amberflo.io/operations/jobs/results \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/operations/jobs/results", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/operations/jobs/results")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/operations/jobs/results"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
[
  ""
]