--- title: /operations/tracker-runs slug: amberflo-api/3jO7-operationstracker-runs docTags: createdAt: 2024-11-07T15:10:16.969Z --- { "id": "ypmugAo9ETSl_P7yjOSL8", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/operations/tracker-runs", "servers": [ { "url": "https://app.amberflo.io/operations/tracker-runs" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "operations.tracker.tracker_run.TrackerRunPayload.in", "schema": [ { "name": "result", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.QueryToolResult.in", "customType": "operations.query_tool.QueryToolResult.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.query_tool.aoa_meters_failure.AoaMetersFailureResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.aoa_meters_failure.AoaMetersFailureResult.in", "schema": [] }, { "name": "operations.query_tool.commitment_validation.CommitmentValidationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.CommitmentValidationResult.in", "schema": [ { "name": "commitmentPurchasedPrepaidCards", "kind": "required", "type": "array", "description": "Prepaid purchased for the commitment.", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCard.in", "customType": "payment.billing.prepaid_to_product.PrepaidCard.in[]", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.in", "customType": "payment.payment.PaymentStatus.in", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.in", "customType": "payment.billing.detailed.EntityProductInvoice.in[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "transferInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.PrepaidTransferInvoice.in", "customType": "payment.billing.detailed.PrepaidTransferInvoice.in[]", "schema": [ { "name": "requestId", "kind": "optional", "type": "string", "example": "" }, { "name": "destinationPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.in", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.in", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.in", "customType": "payment.billing.PaymentCurrencyInfo.in", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.in", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.in", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.in", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "appliedPromotions", "kind": "required", "type": "array", "description": "List of promotions that were applied during the queried time range.", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.in", "customType": "payment.pricing.customer.CustomerAppliedPromotion.in[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "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).", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Unique product id.", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique promotion id to define an applied promotion.", "example": "" }, { "name": "appliedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Deprecated. When a promotion is in use in a customer pricing plan.", "example": 0 }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been added to a pricing plan.", "example": 0 }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been removed from a customer pricing plan.", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "description": "The unique ID of the relationship between the customer and promotion.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "When something is applied and removed with hourly granularity.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priority", "kind": "optional", "type": "number", "description": "How we rank promotions of the same type against each other.", "example": "" }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Identifying metadata around who and why a promotion was removed.", "example": "", "customType": "map", "schema": [] }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Optional field, populated by internal processes.", "example": "" }, { "name": "entityProductInvoices", "kind": "optional", "type": "array", "description": "List of invoices that this customer applied promotion was used on.", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.in", "customType": "payment.billing.detailed.EntityProductInvoice.in[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "amountLeftInCycle", "kind": "optional", "type": "number", "description": "Amount of promotion left in cycle.", "example": "" }, { "name": "totalAmountLeft", "kind": "optional", "type": "number", "description": "Amount of promotion left in total.", "example": "" } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "List of validation data points for a commitment contract's invoices.", "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.CommitmentValidationDataPoint.in", "customType": "operations.query_tool.commitment_validation.CommitmentValidationDataPoint.in[]", "schema": [ { "name": "invoiceKey", "kind": "required", "type": "object", "description": "A commitment contract's invoice.", "modelRef": "#/components/schemas/payment.billing.CustomerProductInvoiceKey.in", "customType": "payment.billing.CustomerProductInvoiceKey.in", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "year", "kind": "optional", "type": "integer", "example": 0 }, { "name": "month", "kind": "optional", "type": "integer", "example": 0 }, { "name": "day", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "isPricingPlanLocked", "kind": "required", "type": "boolean", "description": "Whether the pricing plan is locked.", "example": "" }, { "name": "trueUpObligationsWithStatus", "kind": "required", "type": "array", "description": "List of customer obligations with true-up.", "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.TrueUpObligationWithStatus.in", "customType": "operations.query_tool.commitment_validation.TrueUpObligationWithStatus.in[]", "schema": [ { "name": "trueUpObligation", "kind": "required", "type": "object", "description": "Customer obligations with true-up.", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.MinTotalPrice.in", "customType": "payment.pricing.commitments.customer.MinTotalPrice.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "obligationStatus", "kind": "required", "type": "object", "description": "The obligation status of the true-up customer obligation.", "modelRef": "#/components/schemas/payment.pricing.commitments.ObligationStatus.in", "customType": "payment.pricing.commitments.ObligationStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsResult.in", "schema": [] }, { "name": "operations.query_tool.custom_aggregation_validation.CustomAggregationValidationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_validation.CustomAggregationValidationResult.in", "schema": [] }, { "name": "operations.query_tool.customer_promotion_explain.CustomerPromotionExplainResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerPromotionExplainResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.data_sync_object_counts.DataSyncObjectCountsResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.events_filtering_validation.EventsFilteringValidationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.events_filtering_validation.EventsFilteringValidationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.QueryToolExceptionResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.QueryToolExceptionResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.file_search_verification.FileSearchResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.file_search_verification.FileSearchResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_explain.InvoiceExplainResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_explain.InvoiceExplainResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.long_lasting_explain.LongLastingExplainResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.long_lasting_verification.LongLastingVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_verification.LongLastingVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.marketplace_payments.MarketplacePaymentsResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.marketplace_payments.MarketplacePaymentsResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.meter_event_dedupe.MeterEventDedupeResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.meter_event_dedupe.MeterEventDedupeResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.platform_jobs_api.PlatformJobsApiResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobsApiResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.stripe_payment_verification.StripePaymentVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.usage_monitoring.UsageMonitoringResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.usage_monitoring.UsageMonitoringResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.usage_verification.UsageVerificationResult.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.usage_verification.UsageVerificationResult.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "query", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.Query.in", "customType": "operations.query_tool.Query.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.query_tool.sqs_statuses_verification.usage_sqs_status.AggregatorProcessedIngestMessagesFifoParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.sqs_statuses_verification.usage_sqs_status.AggregatorProcessedIngestMessagesFifoParams.in", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "aggregator-processed-ingest-messages" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.in", "customType": "common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "period", "kind": "required", "type": "integer", "description": "Interval Window (in seconds) of results to get from Cloudwatch", "example": 0 } ] }, { "name": "operations.query_tool.aoa_meters_failure.AoaMetersFailureParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.aoa_meters_failure.AoaMetersFailureParams.in", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "aoa_meters_failure" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.in", "customType": "common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] } ] }, { "name": "operations.query_tool.commitment_validation.CommitmentValidationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.CommitmentValidationParams.in", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "commitment_validation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.in", "customType": "common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "accountId", "kind": "optional", "type": "string", "description": "`accountId` specific for jobs.", "example": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "An account's customer", "example": "" } ] }, { "name": "operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsParams.in", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "custom_aggregation_timestamps" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.in", "customType": "common.TimeRange.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "accountId", "kind": "optional", "type": "string", "description": "`accountId` specific for jobs.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ] }, { "name": "operations.query_tool.custom_aggregation_validation.CustomAggregationValidationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_validation.CustomAggregationValidationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.customer_promotion_explain.CustomerPromotionExplainParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerPromotionExplainParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.events_filtering_validation.EventsFilteringValidationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.events_filtering_validation.EventsFilteringValidationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.file_search_verification.FileSearchParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.file_search_verification.FileSearchParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_explain.InvoiceExplainParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_explain.InvoiceExplainParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.long_lasting_explain.LongLastingExplainParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.long_lasting_verification.LongLastingVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_verification.LongLastingVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.marketplace_payments.MarketplacePaymentsParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.marketplace_payments.MarketplacePaymentsParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.meter_event_dedupe.MeterEventDedupeParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.meter_event_dedupe.MeterEventDedupeParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.platform_jobs_api.PlatformJobsApiParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobsApiParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.usage_monitoring.UsageMonitoringParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.usage_monitoring.UsageMonitoringParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.query_tool.usage_verification.UsageVerificationParams.in", "description": "", "modelRef": "#/components/schemas/operations.query_tool.usage_verification.UsageVerificationParams.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ], "modelRef": "#/components/schemas/operations.tracker.tracker_run.TrackerRunPayload.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "operations.tracker.tracker_run.TrackerRunInfo.out", "schema": [ { "name": "trackerRunId", "kind": "optional", "type": "string", "example": "" }, { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "creationTime", "kind": "optional", "type": "integer", "example": 0 }, { "name": "owner", "kind": "optional", "type": "string", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "" }, { "name": "queryToolPayload", "kind": "optional", "type": "string", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "resolutionStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/operations.tracker.tracker_run.ResolutionStatus.out", "customType": "operations.tracker.tracker_run.ResolutionStatus.out", "schema": [] }, { "name": "updates", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/operations.tracker.tracker_run.TrackerRunUpdate.out", "customType": "operations.tracker.tracker_run.TrackerRunUpdate.out[]", "schema": [ { "name": "userId", "kind": "optional", "type": "string", "example": "" }, { "name": "timestamp", "kind": "optional", "type": "integer", "example": 0 }, { "name": "comment", "kind": "optional", "type": "string", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.tracker.tracker_run.TrackerRunInfo.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "028KaDLRirG_DcEdlpqLJ", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/operations/tracker-runs \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"result\": {},\n \"query\": {\n \"type\": \"aggregator-processed-ingest-messages\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"period\": 0\n }\n }'" }, { "id": "qgoZ9sPdqDD9Gl4q5_ElJ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"result\": {},\n \"query\": {\n \"type\": \"aggregator-processed-ingest-messages\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"period\": 0\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/operations/tracker-runs\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WCj9cUVSMSU98btGnpAHy", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/operations/tracker-runs\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"result\": {},\n \"query\": {\n \"type\": \"aggregator-processed-ingest-messages\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"period\": 0\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "4Az1wKJ0aHofMu-iaWsmV", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/operations/tracker-runs\"\n\npayload = json.dumps({\n \"result\": {},\n \"query\": {\n \"type\": \"aggregator-processed-ingest-messages\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"period\": 0\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "028KaDLRirG_DcEdlpqLJ" }, "results": { "languages": [ { "id": "w8CczO5_SucjGhY0G-syr", "language": "200", "code": "// Successful request\n{\n \"trackerRunId\": \"\",\n \"accountId\": \"\",\n \"creationTime\": \"\",\n \"owner\": \"\",\n \"type\": \"\",\n \"queryToolPayload\": \"\",\n \"status\": \"\",\n \"summary\": [\n \"\"\n ],\n \"resolutionStatus\": \"\",\n \"updates\": [\n {\n \"userId\": \"\",\n \"timestamp\": \"\",\n \"comment\": \"\"\n }\n ]\n}" } ], "selectedLanguageId": "w8CczO5_SucjGhY0G-syr" } }, "children": [ { "text": "" } ] }