--- title: /operations/query-tool/hourly_hourly_to_daily_hourly_validation slug: amberflo-api/operationsquery-toolhourlyhourlytodailyhourlyvalidation docTags: createdAt: 2024-11-07T15:10:16.970Z --- { "id": "FGyIqvm_L645ugMvqlMYl", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation", "servers": [ { "url": "https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.in", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "hourly_hourly_to_daily_hourly_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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ], "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.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.query_tool.QueryToolResult.out", "schema": [], "modelRef": "#/components/schemas/operations.query_tool.QueryToolResult.out", "complexItems": [ { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "aoa_meters_failure" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/operations.query_tool.aoa_meters_failure.AoaMetersFailureResult.out", "customType": "operations.query_tool.aoa_meters_failure.AoaMetersFailureResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "commitment_validation" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.CommitmentValidationParams.out", "customType": "operations.query_tool.commitment_validation.CommitmentValidationParams.out", "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.out", "customType": "common.TimeRange.out", "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": "commitmentPurchasedPrepaidCards", "kind": "required", "type": "object", "description": "Prepaid purchased for the commitment.", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCard.out", "customType": "payment.billing.prepaid_to_product.PrepaidCard.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.PrepaidCardByPrice.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByPrice.out", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "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.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "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.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "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.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "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.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "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": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_price" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "actualPrepaidChargePrice", "kind": "optional", "type": "number", "description": "The actual absolute charge amount for the prepaid card, in base currency.", "example": "" } ] }, { "name": "payment.billing.prepaid_to_product.PrepaidCardByUsage.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByUsage.out", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "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.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "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.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "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.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "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.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "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": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_usage" }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] } ] } ] }, { "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.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out[]", "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.out", "customType": "payment.common.TimeRange.out", "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.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "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.out", "customType": "operations.query_tool.commitment_validation.CommitmentValidationDataPoint.out[]", "schema": [ { "name": "invoiceKey", "kind": "required", "type": "object", "description": "A commitment contract's invoice.", "modelRef": "#/components/schemas/payment.billing.CustomerProductInvoiceKey.out", "customType": "payment.billing.CustomerProductInvoiceKey.out", "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.out", "customType": "operations.query_tool.commitment_validation.TrueUpObligationWithStatus.out[]", "schema": [ { "name": "trueUpObligation", "kind": "required", "type": "object", "description": "Customer obligations with true-up.", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.MinTotalPrice.out", "customType": "payment.pricing.commitments.customer.MinTotalPrice.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "min_total_price" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalPriceCommitted", "kind": "optional", "type": "integer", "example": 0 }, { "name": "usePriceAfterDiscounts", "kind": "optional", "type": "boolean", "example": "" }, { "name": "subtractCommitmentPrepaid", "kind": "optional", "type": "boolean", "example": "" }, { "name": "cycleObligation", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "obligationStatus", "kind": "required", "type": "object", "description": "The obligation status of the true-up customer obligation.", "modelRef": "#/components/schemas/payment.pricing.commitments.ObligationStatus.out", "customType": "payment.pricing.commitments.ObligationStatus.out", "schema": [ { "name": "obligationId", "kind": "optional", "type": "string", "example": "" }, { "name": "isCommitmentFullyMet", "kind": "optional", "type": "boolean", "example": "" }, { "name": "violationFound", "kind": "optional", "type": "boolean", "example": "" }, { "name": "shouldCancelCommitment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "violations", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.ObligationViolation.out", "customType": "payment.pricing.commitments.ObligationViolation.out[]", "schema": [ { "name": "feeAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "violationMeasure", "kind": "optional", "type": "number", "example": "" }, { "name": "violatedInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.CustomerProductInvoiceKey.out", "customType": "payment.billing.CustomerProductInvoiceKey.out[]", "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": "invoiceToPay", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.CustomerProductInvoiceKey.out", "customType": "payment.billing.CustomerProductInvoiceKey.out", "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 } ] } ] } ] } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.commitment_validation.CommitmentValidationResult.out", "customType": "operations.query_tool.commitment_validation.CommitmentValidationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "custom_aggregation_timestamps" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsParams.out", "customType": "operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsParams.out", "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.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsDatapoint.out", "customType": "operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsDatapoint.out[]", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "The id for an account.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "The id for the meterApi", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The id of the custom aggregation spec.", "example": "" }, { "name": "groupBy", "kind": "required", "type": "array", "description": "The dimensions of the meter's custom aggregation group", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "hourlyHourlyLastModifiedTimeInSeconds", "kind": "required", "type": "integer", "description": "The value for the hourly-hourly aggregation.", "example": 0 }, { "name": "customAggregationLastModifiedTimeInSeconds", "kind": "required", "type": "integer", "description": "The value for the custom group aggregation.", "example": 0 } ] } ], "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsResult.out", "customType": "operations.query_tool.custom_aggregation_timestamps.CustomAggregationTimestampsResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "custom_aggregation_validation" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_validation.CustomAggregationValidationParams.out", "customType": "operations.query_tool.custom_aggregation_validation.CustomAggregationValidationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "custom_aggregation_validation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "timeGroupingInterval", "kind": "required", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor 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.\n\nOn 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.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "filter", "kind": "optional", "type": "map", "description": "Filter for a list of dimensions to determine a specific Custom Aggregation to validate.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "comparisonPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_validation.CustomAggregationComparisonPoint.out", "customType": "operations.query_tool.custom_aggregation_validation.CustomAggregationComparisonPoint.out[]", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "The id for an account.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "The id for the meterApi", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The id of the custom aggregation spec.", "example": "" }, { "name": "groupBy", "kind": "required", "type": "array", "description": "The dimensions of the meter's custom aggregation group", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "timeGroupingIntervalValue", "kind": "required", "type": "number", "description": "The value for the summed hourly-hourly or summed daily-hourly aggregation.", "example": "" }, { "name": "customAggregationValue", "kind": "required", "type": "number", "description": "The value for the custom aggregation.", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between summed hourly-hourly and custom aggregation.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.custom_aggregation_validation.CustomAggregationValidationResult.out", "customType": "operations.query_tool.custom_aggregation_validation.CustomAggregationValidationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "customer_promotion_explain" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerPromotionExplainParams.out", "customType": "operations.query_tool.customer_promotion_explain.CustomerPromotionExplainParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "customer_promotion_explain" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "report", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerPromotionExplainReport.out", "customType": "operations.query_tool.customer_promotion_explain.CustomerPromotionExplainReport.out", "schema": [ { "name": "applicablePromotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.InvoiceAppliedPromotionExplained.out", "customType": "operations.query_tool.customer_promotion_explain.InvoiceAppliedPromotionExplained.out[]", "schema": [ { "name": "invoiceAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.InvoiceAppliedPromotion.out", "customType": "payment.billing.InvoiceAppliedPromotion.out", "schema": [ { "name": "customerAppliedPromotionId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionName", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.out", "customType": "payment.pricing.promotions.attributes.PromotionType.out", "schema": [] }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "hourlyDiscounts", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "promotionAppliedTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "maxDiscountPossible", "kind": "optional", "type": "number", "example": "" }, { "name": "canBeUsedForPayAsYouGo", "kind": "optional", "type": "boolean", "example": "" }, { "name": "granularity", "kind": "optional", "type": "string", "example": "" }, { "name": "entityTd", "kind": "optional", "type": "string", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "promotionAppliedTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] } ] }, { "name": "explanation", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "addedDuringBillingPeriod", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out", "customType": "operations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out[]", "schema": [ { "name": "customerAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out", "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.out", "customType": "payment.common.TimeRange.out", "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.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "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": "explanation", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "removedDuringBillingPeriod", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out", "customType": "operations.query_tool.customer_promotion_explain.CustomerAppliedPromotionExplained.out[]", "schema": [ { "name": "customerAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out", "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.out", "customType": "payment.common.TimeRange.out", "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.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "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": "explanation", "kind": "optional", "type": "string", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.customer_promotion_explain.CustomerPromotionExplainResult.out", "customType": "operations.query_tool.customer_promotion_explain.CustomerPromotionExplainResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "data_sync_object_counts" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dataSyncObjectCounts", "kind": "optional", "type": "object", "description": "The object counts for the account.", "modelRef": "#/components/schemas/operations.DataSyncObjectCounts.out", "customType": "operations.DataSyncObjectCounts.out", "schema": [ { "name": "objectCounts", "kind": "optional", "type": "map", "description": "Map of object names to their count totals.", "example": "", "customType": "map", "schema": [] }, { "name": "computedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Time in seconds at which the object counts were computed.", "example": 0 } ] } ], "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsResult.out", "customType": "operations.query_tool.data_sync_object_counts.DataSyncObjectCountsResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "events_filtering_validation" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.events_filtering_validation.EventsFilteringValidationParams.out", "customType": "operations.query_tool.events_filtering_validation.EventsFilteringValidationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "events_filtering_validation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "A customerId to narrow down the search for event filtering rules.", "example": "" } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "Relevant filtering rules", "modelRef": "#/components/schemas/operations.query_tool.events_filtering_validation.EventsFilteringDataPoint.out", "customType": "operations.query_tool.events_filtering_validation.EventsFilteringDataPoint.out[]", "schema": [ { "name": "filteringOutRule", "kind": "required", "type": "object", "description": "The filtering rule applied to events", "modelRef": "#/components/schemas/ingestion.s3_snapshot.filtering_rules.ByPropertyFilteringOutRule.out", "customType": "ingestion.s3_snapshot.filtering_rules.ByPropertyFilteringOutRule.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "ingestionTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ingestion.s3_snapshot.common.TimeRange.out", "customType": "ingestion.s3_snapshot.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "meterApiName", "kind": "optional", "type": "string", "example": "" }, { "name": "dimensionValuesMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "failedValidations", "kind": "required", "type": "array", "description": "List of events that were not filtered out by rule.", "modelRef": "#/components/schemas/usage.aggregations.IngestMessage.out", "customType": "usage.aggregations.IngestMessage.out[]", "schema": [ { "name": "meterApiName", "kind": "optional", "type": "string", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "example": "" }, { "name": "meterTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "dimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.events_filtering_validation.EventsFilteringValidationResult.out", "customType": "operations.query_tool.events_filtering_validation.EventsFilteringValidationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "exception" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/operations.query_tool.QueryToolExceptionResult.out", "customType": "operations.query_tool.QueryToolExceptionResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "file_search" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.file_search_verification.FileSearchMetadata.out", "customType": "operations.query_tool.file_search_verification.FileSearchMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "file_search" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor 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.\n\nOn 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.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "Applicable dimensions for the meter. Used to speed up search", "example": "", "customType": "map", "schema": [] }, { "name": "searchType", "kind": "required", "type": "string", "description": "Used to determine which files to search. Use 'aggregate', 'raw' or 'ingest'", "modelRef": "#/components/schemas/operations.query_tool.file_search_verification.SearchType.out", "customType": "operations.query_tool.file_search_verification.SearchType.out", "schema": [] }, { "name": "timeNormalized", "kind": "optional", "type": "boolean", "description": "Optional param; if set, is used to determine which timeNormalized files to search. Applicable only to 'raw' valueType", "example": "" }, { "name": "value", "kind": "required", "type": "number", "description": "The value to search for", "example": "" }, { "name": "range", "kind": "optional", "type": "number", "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'.", "example": "" } ] }, { "name": "exactAggregateMatches", "kind": "required", "type": "array", "description": "List of the exact matches found for an aggregate search", "modelRef": "#/components/schemas/usage.MeterAggregation.out", "customType": "usage.MeterAggregation.out[]", "schema": [ { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.out", "customType": "usage.MeterAggregationMetadata.out", "schema": [ { "name": "account", "kind": "optional", "type": "string", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "aggregation", "kind": "optional", "type": "string", "description": "Aggregation function. If not specified, the default is obtained from the associated meter definition.", "modelRef": "#/components/schemas/usage.AggregationType.out", "customType": "usage.AggregationType.out", "schema": [] }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole.\n\nValid values are:\n- `customerId`\n- `customerName`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "take", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.Take.out", "customType": "usage.MeterAggregationMetadata.Take.out", "schema": [ { "name": "limit", "kind": "required", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor 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.\n\nOn 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.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "valuesTimeGroupingInterval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "rescaleFunction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.out", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.out", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "clientMeters", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.MeterAggregationGroup.out", "customType": "usage.MeterAggregation.MeterAggregationGroup.out[]", "schema": [ { "name": "group", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.GroupInfo.out", "customType": "usage.MeterAggregation.GroupInfo.out", "schema": [ { "name": "groupInfo", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "groupValue", "kind": "optional", "type": "number", "example": "" }, { "name": "values", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.AggregationValue.out", "customType": "usage.MeterAggregation.AggregationValue.out[]", "schema": [ { "name": "value", "kind": "optional", "type": "number", "example": "" }, { "name": "secondsSinceEpochUtc", "kind": "optional", "type": "integer", "example": 0 } ] } ] } ] }, { "name": "rangedAggregateMatches", "kind": "required", "type": "array", "description": "List of the matches found, in range, for an aggregate search", "modelRef": "#/components/schemas/usage.MeterAggregation.out", "customType": "usage.MeterAggregation.out[]", "schema": [ { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.out", "customType": "usage.MeterAggregationMetadata.out", "schema": [ { "name": "account", "kind": "optional", "type": "string", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "aggregation", "kind": "optional", "type": "string", "description": "Aggregation function. If not specified, the default is obtained from the associated meter definition.", "modelRef": "#/components/schemas/usage.AggregationType.out", "customType": "usage.AggregationType.out", "schema": [] }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole.\n\nValid values are:\n- `customerId`\n- `customerName`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "take", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.Take.out", "customType": "usage.MeterAggregationMetadata.Take.out", "schema": [ { "name": "limit", "kind": "required", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor 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.\n\nOn 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.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "valuesTimeGroupingInterval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "rescaleFunction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.out", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.out", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "clientMeters", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.MeterAggregationGroup.out", "customType": "usage.MeterAggregation.MeterAggregationGroup.out[]", "schema": [ { "name": "group", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.GroupInfo.out", "customType": "usage.MeterAggregation.GroupInfo.out", "schema": [ { "name": "groupInfo", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "groupValue", "kind": "optional", "type": "number", "example": "" }, { "name": "values", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregation.AggregationValue.out", "customType": "usage.MeterAggregation.AggregationValue.out[]", "schema": [ { "name": "value", "kind": "optional", "type": "number", "example": "" }, { "name": "secondsSinceEpochUtc", "kind": "optional", "type": "integer", "example": 0 } ] } ] } ] }, { "name": "nonExistentFiles", "kind": "required", "type": "array", "description": "Any files that did not exist in the search, applicable to an aggregate search", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "exactRawMatches", "kind": "required", "type": "array", "description": "List of the exact matches found for a raw or ingest search", "modelRef": "#/components/schemas/ingestion.s3_snapshot.IngestMessage.out", "customType": "ingestion.s3_snapshot.IngestMessage.out[]", "schema": [ { "name": "meterApiName", "kind": "optional", "type": "string", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "example": "" }, { "name": "meterTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "sourcePath", "kind": "optional", "type": "string", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "rangedRawMatches", "kind": "required", "type": "array", "description": "List of the matches found, in range, for a raw or ingest search", "modelRef": "#/components/schemas/ingestion.s3_snapshot.IngestMessage.out", "customType": "ingestion.s3_snapshot.IngestMessage.out[]", "schema": [ { "name": "meterApiName", "kind": "optional", "type": "string", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "example": "" }, { "name": "meterTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "sourcePath", "kind": "optional", "type": "string", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "exactRawParquetMatches", "kind": "required", "type": "array", "description": "List of the exact matches found for a raw or ingest search", "modelRef": "#/components/schemas/ingestion.IngestMessage.out", "customType": "ingestion.IngestMessage.out[]", "schema": [ { "name": "uniqueId", "kind": "optional", "type": "string", "description": "Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.", "example": "" }, { "name": "meterApiName", "kind": "optional", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).\n\nRequired if `values` is not set or empty.", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "description": "Meter value to be ingested. This will be used for aggregation.\n\nRequired if `values` is not set or empty.", "example": "" }, { "name": "meterTimeInMillis", "kind": "required", "type": "integer", "description": "Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "customerId", "kind": "required", "type": "string", "description": "`customerId` as defined in [Customer API](ref:post_customers).", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).", "example": "", "customType": "map", "schema": [] }, { "name": "variants", "kind": "optional", "type": "array", "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.\n\nMay not be used together with the `values` field.", "modelRef": "#/components/schemas/ingestion.IngestMessage.Variant.out", "customType": "ingestion.IngestMessage.Variant.out[]", "schema": [ { "name": "meterApiName", "kind": "optional", "type": "string", "description": "See the main `meterApiName` field.", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "description": "See the main `meterValue` field.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "See the main `dimension` field.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "values", "kind": "optional", "type": "map", "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\n\nMay only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "rangedRawParquetMatches", "kind": "required", "type": "array", "description": "List of the matches found, in range, for a raw or ingest search", "modelRef": "#/components/schemas/ingestion.IngestMessage.out", "customType": "ingestion.IngestMessage.out[]", "schema": [ { "name": "uniqueId", "kind": "optional", "type": "string", "description": "Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.", "example": "" }, { "name": "meterApiName", "kind": "optional", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).\n\nRequired if `values` is not set or empty.", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "description": "Meter value to be ingested. This will be used for aggregation.\n\nRequired if `values` is not set or empty.", "example": "" }, { "name": "meterTimeInMillis", "kind": "required", "type": "integer", "description": "Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "customerId", "kind": "required", "type": "string", "description": "`customerId` as defined in [Customer API](ref:post_customers).", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).", "example": "", "customType": "map", "schema": [] }, { "name": "variants", "kind": "optional", "type": "array", "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.\n\nMay not be used together with the `values` field.", "modelRef": "#/components/schemas/ingestion.IngestMessage.Variant.out", "customType": "ingestion.IngestMessage.Variant.out[]", "schema": [ { "name": "meterApiName", "kind": "optional", "type": "string", "description": "See the main `meterApiName` field.", "example": "" }, { "name": "meterValue", "kind": "optional", "type": "number", "description": "See the main `meterValue` field.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "See the main `dimension` field.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "values", "kind": "optional", "type": "map", "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\n\nMay only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.", "example": "", "customType": "map", "schema": [] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.file_search_verification.FileSearchResult.out", "customType": "operations.query_tool.file_search_verification.FileSearchResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "hourly_hourly_to_daily_hourly_validation" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.out", "customType": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "hourly_hourly_to_daily_hourly_validation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyComparisonDataPoint.out", "customType": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyComparisonDataPoint.out[]", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "The id for an account.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "The id for the meterApi", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "hourlyHourlyValue", "kind": "required", "type": "number", "description": "The value for the hourly-hourly aggregation.", "example": "" }, { "name": "dailyHourlyValue", "kind": "required", "type": "number", "description": "The value for the dail-hourly aggregation.", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between hourly-hourly and daily-hourly.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationResult.out", "customType": "operations.query_tool.hourly_hourly_to_daily_hourly_validation.HourlyHourlyToDailyHourlyValidationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "invoice_explain" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_explain.InvoiceExplainParams.out", "customType": "operations.query_tool.invoice_explain.InvoiceExplainParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "invoice_explain" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" } ] }, { "name": "report", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.invoice_explain.InvoiceExplainReport.out", "customType": "operations.query_tool.invoice_explain.InvoiceExplainReport.out", "schema": [ { "name": "validInvoiceUsage", "kind": "optional", "type": "boolean", "example": "" }, { "name": "mapMeterNameToFailedInvoiceUsageToUsagePoint", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "validPrepaidCredits", "kind": "optional", "type": "boolean", "example": "" }, { "name": "prepaidCreditsComparisonPoint", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.out", "customType": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.out", "schema": [ { "name": "usedPriceCreditsOnInvoice", "kind": "required", "type": "number", "description": "The number of used price credits that is stated in our invoice.", "example": "" }, { "name": "priceCreditsRemainingOnInvoice", "kind": "required", "type": "number", "description": "The number of available price credits that can be used toward the customers current invoice.", "example": "" }, { "name": "usedUsageCreditsOnInvoice", "kind": "required", "type": "number", "description": "The number of used usage credits that is stated in our invoice.", "example": "" }, { "name": "usageCreditsRemainingOnInvoice", "kind": "required", "type": "number", "description": "The number of available usage credits that can be used toward the customers current invoice.", "example": "" }, { "name": "totalCreditsOnInvoice", "kind": "required", "type": "number", "description": "The total (price & usage) credit price amount in our invoice.", "example": "" }, { "name": "usedPriceCreditsInWallet", "kind": "required", "type": "number", "description": "The number of used price credits seen in a customer's wallet.", "example": "" }, { "name": "priceCreditsRemainingInWallet", "kind": "required", "type": "number", "description": "The number of available price credits seen in a customer's wallet.", "example": "" }, { "name": "usedUsageCreditsInWallet", "kind": "required", "type": "number", "description": "The number of used usage credits seen in a customer's wallet.", "example": "" }, { "name": "usageCreditsRemainingInWallet", "kind": "required", "type": "number", "description": "The number of available usage credits seen in a customer's wallet.", "example": "" }, { "name": "totalCreditsInWallet", "kind": "required", "type": "number", "description": "The total (price & usage) credit price amount in a customer's wallet.", "example": "" } ] }, { "name": "validJournal", "kind": "optional", "type": "boolean", "example": "" }, { "name": "noLateArrivals", "kind": "optional", "type": "boolean", "example": "" }, { "name": "lateArrivalEvents", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "plan", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.ProductPlan.out", "customType": "payment.pricing.ProductPlan.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productItemPriceIdsMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "billingPeriod", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "productPlanName", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "feeMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "type", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.out", "customType": "payment.pricing.prepaid.PrepaidProductItem.out[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item id that is associated with amount of prepaid.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid amount that is associated with the object.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planGenerator", "kind": "optional", "type": "object", "description": "The template of the plan generator", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PlanGenerator.out", "customType": "payment.pricing.plans.generators.PlanGenerator.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.plans.generators.CustomPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.CustomPlanGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "custom_pricing_plan" }, { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fee Id to fee that maps to product plan fee.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.out", "customType": "payment.pricing.prepaid.PrepaidProductItem.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Can be any price generator.", "modelRef": "#/components/schemas/payment.pricing.price.generators.PriceGenerator.out", "customType": "payment.pricing.price.generators.PriceGenerator.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.out", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.plans.generators.FlatRatePlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.FlatRatePlanGenerator.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "array", "description": "List of price generators to use in the plan. Must be strictly flat rate.", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "customType": "payment.pricing.price.generators.FlatRatePriceGenerator.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "billsByProductItem", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "totalProductPlanFees", "kind": "optional", "type": "number", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.invoice_explain.InvoiceExplainResult.out", "customType": "operations.query_tool.invoice_explain.InvoiceExplainResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "invoice_late_arrivals_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationParams.out", "customType": "operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "invoice_late_arrivals_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" }, { "name": "filter", "kind": "optional", "type": "map", "description": "Filter for which meter to filter usage on.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "trueLateArrivals", "kind": "optional", "type": "map", "description": "The true late arrival events", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationResult.out", "customType": "operations.query_tool.invoice_late_arrivals_verification.InvoiceLateArrivalsVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "invoice_usage_costs_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationMetadata.out", "customType": "operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "invoice_usage_costs_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" }, { "name": "source", "kind": "required", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsComparisonPoint.out", "customType": "operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsComparisonPoint.out[]", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "The name of the billable meter.", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "indexedValue", "kind": "required", "type": "number", "description": "The value that is aggregated or seen in Amberflo's system.", "example": "" }, { "name": "invoiceValue", "kind": "required", "type": "number", "description": "The meter values used to compute a customer's invoice.", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference our usage cost and the source at a specific time window.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationResult.out", "customType": "operations.query_tool.invoice_usage_costs_verification.InvoiceUsageCostsVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "invoice_usage_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.out", "customType": "operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "invoice_usage_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" }, { "name": "filter", "kind": "optional", "type": "map", "description": "Filter for which meter to filter usage on.", "example": "", "customType": "map", "schema": [] }, { "name": "source", "kind": "optional", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "map", "description": "All the data points found within the time window.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationResult.out", "customType": "operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "item_invoice_usage_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.out", "customType": "operations.query_tool.invoice_usage_verification.InvoiceUsageVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "invoice_usage_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" }, { "name": "filter", "kind": "optional", "type": "map", "description": "Filter for which meter to filter usage on.", "example": "", "customType": "map", "schema": [] }, { "name": "source", "kind": "optional", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "map", "description": "All the data points found within the time window.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationResult.out", "customType": "operations.query_tool.item_invoice_usage_verificaion.ItemInvoiceUsageVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "locked_invoice_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationMetadata.out", "customType": "operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "locked_invoice_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" }, { "name": "source", "kind": "required", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "invoiceStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.InvoiceStatus.out", "customType": "payment.billing.InvoiceStatus.out", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationResult.out", "customType": "operations.query_tool.locked_invoice_verification.LockedInvoiceVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "long_lasting_explain" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainParams.out", "customType": "operations.query_tool.long_lasting_explain.LongLastingExplainParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "long_lasting_explain" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "A specific customerId. Used to grab metrics pertaining to their usage.", "example": "" } ] }, { "name": "resourceHistories", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainResourceHistory.out", "customType": "operations.query_tool.long_lasting_explain.LongLastingExplainResourceHistory.out[]", "schema": [ { "name": "resourceId", "kind": "optional", "type": "string", "example": "" }, { "name": "mostRecentEventBeforeTimeWindow", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/aggregation_explain.UsageEventInfo.out", "customType": "aggregation_explain.UsageEventInfo.out", "schema": [ { "name": "eventTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "eventTime", "kind": "optional", "type": "string", "example": "" }, { "name": "rate", "kind": "optional", "type": "number", "example": "" }, { "name": "usage", "kind": "optional", "type": "number", "example": "" }, { "name": "durationInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "usageRateAtTimeWindowStart", "kind": "optional", "type": "number", "example": "" }, { "name": "eventsDuringTimeWindow", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/aggregation_explain.UsageEventInfo.out", "customType": "aggregation_explain.UsageEventInfo.out[]", "schema": [ { "name": "eventTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "eventTime", "kind": "optional", "type": "string", "example": "" }, { "name": "rate", "kind": "optional", "type": "number", "example": "" }, { "name": "usage", "kind": "optional", "type": "number", "example": "" }, { "name": "durationInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "usageRateAtTimeWindowEnd", "kind": "optional", "type": "number", "example": "" }, { "name": "usage", "kind": "optional", "type": "number", "example": "" }, { "name": "maxUsageRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "reportSummary", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainReportSummary.out", "customType": "operations.query_tool.long_lasting_explain.LongLastingExplainReportSummary.out", "schema": [ { "name": "configuredTimeoutMinutes", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalAmountOfResourcesStarted", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalUsageRateStarted", "kind": "optional", "type": "number", "example": "" }, { "name": "totalAmountOfResourcesEnded", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalUsageRateEnded", "kind": "optional", "type": "number", "example": "" }, { "name": "totalAmountOfImplicitResources", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalImplicitUsageRate", "kind": "optional", "type": "number", "example": "" }, { "name": "totalUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxUsageRate", "kind": "optional", "type": "number", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.long_lasting_explain.LongLastingExplainResult.out", "customType": "operations.query_tool.long_lasting_explain.LongLastingExplainResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "long_lasting_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_verification.LongLastingVerificationParams.out", "customType": "operations.query_tool.long_lasting_verification.LongLastingVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "long_lasting_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "source", "kind": "optional", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] }, { "name": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.long_lasting_verification.LongLastingComparisonDataPoint.out", "customType": "operations.query_tool.long_lasting_verification.LongLastingComparisonDataPoint.out[]", "schema": [ { "name": "groupId", "kind": "required", "type": "string", "description": "The id for an aggregation group.", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The value that is aggregated or seen in Amberflo's system.", "example": "" }, { "name": "sourceValue", "kind": "required", "type": "number", "description": "The raw events aggregated before entering our pipeline.", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between our usage and source at a specific time window.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.long_lasting_verification.LongLastingVerificationResult.out", "customType": "operations.query_tool.long_lasting_verification.LongLastingVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "marketplace_payments" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.marketplace_payments.MarketplacePaymentsMetadata.out", "customType": "operations.query_tool.marketplace_payments.MarketplacePaymentsMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "marketplace_payments" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "showIntents", "kind": "required", "type": "boolean", "description": "Choose whether to show the intents that fall within the provided timerange", "example": "" }, { "name": "sourceType", "kind": "required", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "intents", "kind": "required", "type": "array", "description": "The list of intents for the provided timerange.", "modelRef": "#/components/schemas/payment.billing.MarketplaceBilledInvoiceIntent.out", "customType": "payment.billing.MarketplaceBilledInvoiceIntent.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "timestamp", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/java.time.Instant.out", "customType": "java.time.Instant.out", "schema": [ { "name": "seconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "nanos", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "invoiceTotalCurrencyFraction", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billedCurrencyFraction", "kind": "optional", "type": "integer", "example": 0 }, { "name": "submitted", "kind": "optional", "type": "boolean", "example": "" }, { "name": "meteringRecordId", "kind": "optional", "type": "string", "example": "" }, { "name": "expired", "kind": "optional", "type": "boolean", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.marketplace_payments.MarketplacePaymentsResult.out", "customType": "operations.query_tool.marketplace_payments.MarketplacePaymentsResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "meter_event_dedupe" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.meter_event_dedupe.MeterDedupeComparisonPoint.out", "customType": "operations.query_tool.meter_event_dedupe.MeterDedupeComparisonPoint.out[]", "schema": [ { "name": "beforeValue", "kind": "required", "type": "number", "description": "The raw events ingested before entering our pipeline.", "example": "" }, { "name": "afterValue", "kind": "required", "type": "number", "description": "The number of events following deduplication.", "example": "" }, { "name": "s3Url", "kind": "required", "type": "string", "description": "The file url to check.", "example": "" }, { "name": "comment", "kind": "required", "type": "string", "description": "Additional information addressing anomalous behavior of this comparison point.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.meter_event_dedupe.MeterEventDedupeResult.out", "customType": "operations.query_tool.meter_event_dedupe.MeterEventDedupeResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "platform_jobs_api" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobsApiParams.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJobsApiParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "platform_jobs_api" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "jobId", "kind": "required", "type": "string", "description": "A unique identifier associated with each job.", "example": "" } ] }, { "name": "job", "kind": "optional", "type": "object", "description": "Job from the Jobs Metadata API", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJob.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJob.out", "schema": [ { "name": "schedulerContext", "kind": "optional", "type": "object", "description": "Context providing details about scheduler's timings and iterations", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJob.SchedulerContext.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJob.SchedulerContext.out", "schema": [ { "name": "previousTime", "kind": "optional", "type": "integer", "description": "The point in time when the last job execution finished.", "example": 0 }, { "name": "nextTime", "kind": "optional", "type": "integer", "description": "The point in time when the next job execution is scheduled.", "example": 0 }, { "name": "iterations", "kind": "optional", "type": "integer", "description": "The total number of iterations this job has executed.", "example": 0 } ] }, { "name": "minimizeFresh", "kind": "optional", "type": "boolean", "description": "Flag indicating whether to minimize the freshness of the data fetched", "example": "" }, { "name": "createTime", "kind": "optional", "type": "integer", "description": "The timestamp of when the job was created", "example": 0 }, { "name": "aggregationBucket", "kind": "optional", "type": "string", "description": "The frequency at which the job data should be aggregated", "example": "" }, { "name": "jobName", "kind": "optional", "type": "string", "description": "Name of the job", "example": "" }, { "name": "s3Url", "kind": "optional", "type": "string", "description": "URL of storage location for the job data", "example": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "description": "Flag indicating whether the job is enabled or not", "example": "" }, { "name": "cron", "kind": "optional", "type": "string", "description": "Cron expression representing the schedule of the job", "example": "" }, { "name": "range", "kind": "optional", "type": "string", "description": "String representing when the data should be fetched from", "example": "" }, { "name": "updateTime", "kind": "optional", "type": "integer", "description": "The timestamp of the last update to the job", "example": 0 }, { "name": "description", "kind": "optional", "type": "string", "description": "Short description of the job", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "A unique identifier for the job", "example": "" }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "A list of dimensions to group the data by", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "meterApiNames", "kind": "optional", "type": "array", "description": "A list of meter API names", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "accountEvents", "kind": "optional", "type": "array", "description": "Job execution account events for the job", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique ID for the event", "example": "" }, { "name": "eventType", "kind": "required", "type": "string", "description": "Type or category of the event", "example": "" }, { "name": "eventTime", "kind": "required", "type": "string", "description": "Timestamp of when the event occurred", "example": "" }, { "name": "details", "kind": "required", "type": "object", "description": "Details of the Job that generated the event", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Details.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Details.out", "schema": [ { "name": "jobId", "kind": "required", "type": "string", "description": "Job ID", "example": "" }, { "name": "query", "kind": "required", "type": "array", "description": "Query List", "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Query.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJobAccountEvent.Query.out[]", "schema": [ { "name": "groupBy", "kind": "required", "type": "array", "description": "List of dimensions that the query aggregates or groups by", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time range for the query", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregation", "kind": "required", "type": "string", "description": "Type of aggregation performed by the query, like SUM, AVG, etc.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "The meter API name for the query", "example": "" } ] }, { "name": "message", "kind": "required", "type": "string", "description": "Message describing the result or status of the job", "example": "" }, { "name": "ranTime", "kind": "required", "type": "integer", "description": "Execution time of the job in milliseconds", "example": 0 }, { "name": "error", "kind": "required", "type": "string", "description": "Error message", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.platform_jobs_api.PlatformJobsApiResult.out", "customType": "operations.query_tool.platform_jobs_api.PlatformJobsApiResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "prepaid_credits_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationParams.out", "customType": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "prepaid_credits_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "invoiceUri", "kind": "required", "type": "string", "description": "The invoiceUri in question", "example": "" } ] }, { "name": "totalUtilization", "kind": "required", "type": "object", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.out", "customType": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsComparisonPoint.out", "schema": [ { "name": "usedPriceCreditsOnInvoice", "kind": "required", "type": "number", "description": "The number of used price credits that is stated in our invoice.", "example": "" }, { "name": "priceCreditsRemainingOnInvoice", "kind": "required", "type": "number", "description": "The number of available price credits that can be used toward the customers current invoice.", "example": "" }, { "name": "usedUsageCreditsOnInvoice", "kind": "required", "type": "number", "description": "The number of used usage credits that is stated in our invoice.", "example": "" }, { "name": "usageCreditsRemainingOnInvoice", "kind": "required", "type": "number", "description": "The number of available usage credits that can be used toward the customers current invoice.", "example": "" }, { "name": "totalCreditsOnInvoice", "kind": "required", "type": "number", "description": "The total (price & usage) credit price amount in our invoice.", "example": "" }, { "name": "usedPriceCreditsInWallet", "kind": "required", "type": "number", "description": "The number of used price credits seen in a customer's wallet.", "example": "" }, { "name": "priceCreditsRemainingInWallet", "kind": "required", "type": "number", "description": "The number of available price credits seen in a customer's wallet.", "example": "" }, { "name": "usedUsageCreditsInWallet", "kind": "required", "type": "number", "description": "The number of used usage credits seen in a customer's wallet.", "example": "" }, { "name": "usageCreditsRemainingInWallet", "kind": "required", "type": "number", "description": "The number of available usage credits seen in a customer's wallet.", "example": "" }, { "name": "totalCreditsInWallet", "kind": "required", "type": "number", "description": "The total (price & usage) credit price amount in a customer's wallet.", "example": "" } ] }, { "name": "utilByCard", "kind": "required", "type": "map", "description": "Break down of util by each prepaid card.", "example": "", "customType": "map", "schema": [] }, { "name": "invoiceUri", "kind": "required", "type": "string", "description": "S3 path to find the current invoice we are verifying.", "example": "" } ], "modelRef": "#/components/schemas/operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationResult.out", "customType": "operations.query_tool.prepaid_credits_verification.PrepaidCreditsVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "rest_api_latency" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationResult.out", "customType": "operations.query_tool.rest_api_latency_verification.RestApiLatencyVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "s3_bucket_ingestion_failures" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "failureCount", "kind": "required", "type": "integer", "description": "Total number of S3 ingestion failure records detected", "example": 0 }, { "name": "s3Uris", "kind": "optional", "type": "array", "description": "List of URIs pointing to the specific S3 objects related to ingestion failures for detailed investigation.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "errorFrequencyMap", "kind": "required", "type": "map", "description": "Map detailing the frequency of each specific ingestion failure error.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresResult.out", "customType": "operations.query_tool.s3_bucket_ingestion_failures.S3BucketIngestionFailuresResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "s3_timestamps_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationParams.out", "customType": "operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "s3_timestamps_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationDatapoint.out", "customType": "operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationDatapoint.out[]", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "The id for an account.", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "The id for the meterApi", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "hourlyHourlyLastModifiedTimeInSeconds", "kind": "required", "type": "integer", "description": "The value for the hourly-hourly aggregation.", "example": 0 }, { "name": "dailyHourlyLastModifiedTimeInSeconds", "kind": "required", "type": "integer", "description": "The value for the dail-hourly aggregation.", "example": 0 } ] } ], "modelRef": "#/components/schemas/operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationResult.out", "customType": "operations.query_tool.s3_timestamps_verification.S3TimestampsVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "salesforce_data_sync" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "Information pertaining to the original request", "modelRef": "#/components/schemas/operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncParams.out", "customType": "operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "salesforce_data_sync" } ] }, { "name": "comparisonMap", "kind": "optional", "type": "map", "description": "Map of comparative analyses between Salesforce and Amberflo object counts.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncResult.out", "customType": "operations.query_tool.data_salesforce_data_sync.SalesforceDataSyncResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "squashable_sum_meter_athena" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaPoint.out", "customType": "operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaPoint.out[]", "schema": [ { "name": "athenaValue", "kind": "required", "type": "number", "description": "Events from Athena.", "example": "" }, { "name": "usageValue", "kind": "required", "type": "number", "description": "Events from Usage.", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between our usage and athena at a specific time window.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaResult.out", "customType": "operations.query_tool.squashable_sum_meter_athena.SquashableSumMeterAthenaResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "stripe_flat_fee_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.out", "customType": "operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "stripe_payment_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "accountStripeId", "kind": "required", "type": "string", "description": "An account's stripeId. If a customer can pay with stripe, an account should receive through stripe.", "example": "" }, { "name": "paymentIntents", "kind": "required", "type": "object", "description": "Each individual customer's invoice and payment status during a time period.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.out", "customType": "operations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.out", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "An account's customer.", "example": "" }, { "name": "stripeId", "kind": "required", "type": "string", "description": "An customer's stripeId.", "example": "" }, { "name": "invoiceUri", "kind": "required", "type": "string", "description": "The current CustomerProductInvoiceKey uri.", "example": "" }, { "name": "invoiceStatus", "kind": "required", "type": "string", "description": "Our stored InvoiceStatus.", "modelRef": "#/components/schemas/payment.billing.InvoiceStatus.out", "customType": "payment.billing.InvoiceStatus.out", "schema": [] }, { "name": "paymentStatus", "kind": "required", "type": "string", "description": "Our stored PaymentStatus.", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "status", "kind": "required", "type": "string", "description": "Our determined outcome based on whether a payment has been made and if it was successful.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripeVerificationStatus.out", "customType": "operations.query_tool.stripe_payment_verification.StripeVerificationStatus.out", "schema": [] }, { "name": "stripePaymentIntent", "kind": "required", "type": "object", "description": "Latest information regarding a customer's stripe payment.", "modelRef": "#/components/schemas/payment.stripe.StripePaymentIntent.out", "customType": "payment.stripe.StripePaymentIntent.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "owner", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripeCustomerId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripePaymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripePaymentStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "internalStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSecondsInStripe", "kind": "optional", "type": "integer", "example": 0 }, { "name": "createdTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "currency", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentMethodId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripeErrorMessage", "kind": "optional", "type": "string", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationResult.out", "customType": "operations.query_tool.stripe_flat_fee_verification.StripeFlatFeeVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "stripe_payment_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining to the original request.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.out", "customType": "operations.query_tool.stripe_payment_verification.StripePaymentVerificationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "stripe_payment_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "accountStripeId", "kind": "required", "type": "string", "description": "An account's stripeId. If a customer can pay with stripe, an account should receive through stripe.", "example": "" }, { "name": "paymentIntents", "kind": "required", "type": "object", "description": "Each individual customer's invoice and payment status during a time period.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.out", "customType": "operations.query_tool.stripe_payment_verification.StripePaymentIntentDetails.out", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "An account's customer.", "example": "" }, { "name": "stripeId", "kind": "required", "type": "string", "description": "An customer's stripeId.", "example": "" }, { "name": "invoiceUri", "kind": "required", "type": "string", "description": "The current CustomerProductInvoiceKey uri.", "example": "" }, { "name": "invoiceStatus", "kind": "required", "type": "string", "description": "Our stored InvoiceStatus.", "modelRef": "#/components/schemas/payment.billing.InvoiceStatus.out", "customType": "payment.billing.InvoiceStatus.out", "schema": [] }, { "name": "paymentStatus", "kind": "required", "type": "string", "description": "Our stored PaymentStatus.", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "status", "kind": "required", "type": "string", "description": "Our determined outcome based on whether a payment has been made and if it was successful.", "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripeVerificationStatus.out", "customType": "operations.query_tool.stripe_payment_verification.StripeVerificationStatus.out", "schema": [] }, { "name": "stripePaymentIntent", "kind": "required", "type": "object", "description": "Latest information regarding a customer's stripe payment.", "modelRef": "#/components/schemas/payment.stripe.StripePaymentIntent.out", "customType": "payment.stripe.StripePaymentIntent.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "owner", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripeCustomerId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripePaymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripePaymentStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "internalStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSecondsInStripe", "kind": "optional", "type": "integer", "example": 0 }, { "name": "createdTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "currency", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentMethodId", "kind": "optional", "type": "string", "example": "" }, { "name": "stripeErrorMessage", "kind": "optional", "type": "string", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/operations.query_tool.stripe_payment_verification.StripePaymentVerificationResult.out", "customType": "operations.query_tool.stripe_payment_verification.StripePaymentVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "ultra_frequency_usage_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationMetadata.out", "customType": "operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "ultra_frequency_usage_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "MAX_INTERVAL_IN_SECONDS", "kind": "optional", "type": "integer", "example": 0 }, { "name": "MIN_ACCEPTABLE_HOURS_BEFORE_NOW", "kind": "optional", "type": "integer", "example": 0 }, { "name": "source", "kind": "required", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageComparisonPoint.out", "customType": "operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageComparisonPoint.out[]", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "The name of the billable meter.", "example": "" }, { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The usage value derived from S3 full aggregations (after going through UF pipeline).", "example": "" }, { "name": "sourceValue", "kind": "required", "type": "number", "description": "The usage value derived from S3 raw events (before going through UF pipeline).", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between our usage and source for a specific time window.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationResult.out", "customType": "operations.query_tool.ultra_frequency_usage_verification.UltraFrequencyUsageVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "usage_monitoring" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.usage_monitoring.UsageMonitoringParams.out", "customType": "operations.query_tool.usage_monitoring.UsageMonitoringParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "usage_monitoring" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.usage_monitoring.UsageMonitoringResult.out", "customType": "operations.query_tool.usage_monitoring.UsageMonitoringResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "usage_sqs_statuses" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationResult.out", "customType": "operations.query_tool.sqs_statuses_verification.usage_sqs_status.UsageSqsStatusesVerificationResult.out" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of QueryToolResult for de-serialization.", "example": "", "default": "usage_verification" }, { "name": "scriptParams", "kind": "required", "type": "object", "description": "Currently unneeded for Custom Aggregations.", "modelRef": "#/components/schemas/operations.jobs.Job.out", "customType": "operations.jobs.Job.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "operations.jobs.scripts.RunBillingJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunBillingJobParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "billing_app" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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.data_sync_object_counts.DataSyncObjectCountsParams.out", "description": "", "modelRef": "#/components/schemas/operations.query_tool.data_sync_object_counts.DataSyncObjectCountsParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "data_sync_object_counts" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The account ID to get object counts for", "example": "" } ] }, { "name": "operations.jobs.scripts.RunCustomAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunCustomAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_custom_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "customAggregationSpecId", "kind": "required", "type": "string", "description": "The ID of the custom aggregation spec", "example": "" } ] }, { "name": "operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunDailyHourlyAggregationParams.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "run_daily_hourly_aggregation" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "aggregationType", "kind": "optional", "type": "string", "description": "The type of aggregation to use, such as sum, count, avg, max, etc. Optional parameter", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationType.out", "customType": "com.amberflo.service.common.aggregation.AggregationType.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "operations.jobs.scripts.RunHourlyAggregationParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunHourlyAggregationParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunIngestSnapshotParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunIngestSnapshotParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunItemInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunItemInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunLockedProductInvoiceParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunLockedProductInvoiceParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunMarketplacePaymentsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunMarketplacePaymentsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageCostsParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageCostsParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "operations.jobs.scripts.RunUsageJobParams.out", "description": "", "modelRef": "#/components/schemas/operations.jobs.scripts.RunUsageJobParams.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "status", "kind": "required", "type": "string", "description": "Overall health of the pipeline during a time window", "modelRef": "#/components/schemas/operations.VerificationStatus.out", "customType": "operations.VerificationStatus.out", "schema": [] }, { "name": "summary", "kind": "required", "type": "array", "description": "A human readable summary of the report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "instructions", "kind": "required", "type": "array", "description": "After a verification is run, we want to determine the next actions an operator should take.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "metadata", "kind": "required", "type": "object", "description": "Information pertaining the original request", "modelRef": "#/components/schemas/operations.query_tool.usage_verification.UsageVerificationMetadata.out", "customType": "operations.query_tool.usage_verification.UsageVerificationMetadata.out", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of query to run", "example": "", "default": "usage_verification" }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "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": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "timeGroupingInterval", "kind": "required", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor 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.\n\nOn 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.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "source", "kind": "required", "type": "string", "description": "Our source of truth for certain meter types.", "modelRef": "#/components/schemas/operations.SourceType.out", "customType": "operations.SourceType.out", "schema": [] } ] }, { "name": "dataPoints", "kind": "required", "type": "array", "description": "All the data points found within the time window.", "modelRef": "#/components/schemas/operations.query_tool.usage_verification.UsageComparisonPoint.out", "customType": "operations.query_tool.usage_verification.UsageComparisonPoint.out[]", "schema": [ { "name": "timeInSeconds", "kind": "required", "type": "integer", "description": "The starting time window of an interval in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The value that is aggregated or seen in Amberflo's system.", "example": "" }, { "name": "sourceValue", "kind": "required", "type": "number", "description": "The raw events aggregated before entering our pipeline.", "example": "" }, { "name": "delta", "kind": "required", "type": "number", "description": "The numeric difference between our usage and source at a specific time window.", "example": "" }, { "name": "comment", "kind": "required", "type": "string", "description": "Additional information addressing anomalous behavior of this comparison point.", "example": "" } ] } ], "modelRef": "#/components/schemas/operations.query_tool.usage_verification.UsageVerificationResult.out", "customType": "operations.query_tool.usage_verification.UsageVerificationResult.out" } ], "complexType": "oneOf", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "4NKg5LSznbjuJ-_jdKpR9", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": \"hourly_hourly_to_daily_hourly_validation\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"meterApiName\": \"\"\n }'" }, { "id": "7UtsrB6Xg7qxraGwQ0TBh", "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 \"type\": \"hourly_hourly_to_daily_hourly_validation\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"meterApiName\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "4jyWvtmaL5Md-C3yzq_9x", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation\")\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 \"type\": \"hourly_hourly_to_daily_hourly_validation\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"meterApiName\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "-ryt86vc6p5xBx_eTR1_2", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/operations/query-tool/hourly_hourly_to_daily_hourly_validation\"\n\npayload = json.dumps({\n \"type\": \"hourly_hourly_to_daily_hourly_validation\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"meterApiName\": \"\"\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": "4NKg5LSznbjuJ-_jdKpR9" }, "results": { "languages": [ { "id": "jXM6AprezQTENQ0mARCNF", "language": "200", "code": "// Successful request\n{}" } ], "selectedLanguageId": "jXM6AprezQTENQ0mARCNF" } }, "children": [ { "text": "" } ] }