Get report dataset
/report-datasets/{reportDatasetId}curl -X GET https://api.tst.au.apgpay.dev/report-datasets/{reportDatasetId} \
-H "Authorization: Bearer $API_KEY"Return one dataset: its dimensions, measures and time grains. The caller may keep the answer for five minutes.
Permissions
reports:queryRequires the `query` action on `reports` for the supplied runtime context
Path parameters
reportDatasetIdstringResponses
The response is a tagged shape: type is always "RdsetAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "RdsetAttributes"reportDatasetIdstringrequiredThe dataset's name, which is also its id.
domainstringrequiredThe subject area the dataset belongs to.
labelstringrequireddescriptionstringrequiredThe time grains a query may bucket by. Empty for a dataset with no time dimension.
typeenumrequiredRdsetGrainAttributesnamestringrequiredExample Ada Lovelace
labelstringrequiredThe rules a question bucketed by this grain is held to.
typeA question with measures returns at most max rows, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A question asking it may ask, beside it, only measures.
measuresarray of stringIt takes at most max values, which a pivot column counts against RdsetRulePivotSize.
maxinteger (int32)requiredExample 1250
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
A question asking it may not hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question may not hold both parts.
firstRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
secondRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
An export holds at most max rows, and is refused rather than cut short when the answer holds more.
maxinteger (int32)requiredExample 1250
A filter on it is one of operators, each naming the RqryFilter subtype of that name; any other is refused.
operatorsarray of RdsetFilterOperatorEqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It is a share within dimensions, so a question asking it groups by each of them and never ranks one with a top.
dimensionsarray of stringA question groups by at most max dimensions.
maxinteger (int32)requiredExample 1250
A question holds at most max measure filters.
maxinteger (int32)requiredExample 1250
A range bucketed by this grain spans at most range, an ISO 8601 period such as P31D.
rangestringrequiredA question asking it must hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is money in the currency dimension holds, so a question asking it groups by that dimension or pins it with an RqryFilterEquals; in a pivot, or under a top ranking that dimension, it pins it.
dimensionstringrequiredIt divides money in the currency dimension holds, so a question asking it pins that dimension with an RqryFilterEquals.
dimensionstringrequiredA question asking it cannot group or filter by dimensions, each a band worked out per group.
dimensionsarray of stringAn RqryFilterContains cannot search it.
An RqryFilterContains cannot search it.
It cannot be filtered on, only grouped by or listed as a row column.
It cannot be filtered on, only grouped by or listed as a row column.
A question asking it cannot filter on dimensions; it may group by them.
dimensionsarray of stringA top cannot rank by it.
A top cannot rank by it.
It is a balance carried from each record's latest change, so a question asking it cannot group or filter by dimensions.
dimensionsarray of stringA measure filter cannot test it.
A measure filter cannot test it.
It is a balance observed by grain snapshots, so it cannot be bucketed by notByGrains or grouped by notByDimensions, whose buckets do not hold whole snapshots. It is summed across dimensions, never across time.
grainstringrequirednotByGrainsarray of stringnotByDimensionsarray of stringA question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A pivot's columns combine to at most maxColumnValues values, by each column dimension's RdsetRuleAtMostValues, and its rows, time and subtotals to at most maxGroupingSets grouping sets.
maxColumnValuesinteger (int32)requiredExample 1250
maxGroupingSetsinteger (int32)requiredExample 1250
The part names only dimensions the question groups by and measures it asks for; a pivot names each grouped dimension once.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question holding part must hold needs too.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
needsRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question with no measures returns at most max rows a page, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A top's count is from 1 to max.
maxinteger (int32)requiredExample 1250
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A filter value is a whole number from first to last; any other can never match.
firstinteger (int32)requiredExample 1250
lastinteger (int32)requiredExample 1250
defaultGrainstringThe grain a client uses when the person has not chosen one.
Only the dimensions this caller may see.
typeenumrequiredRdsetDimensionAttributesnamestringrequiredExample Ada Lovelace
labelstringrequireddescriptionstringrequiredsummarystringrequiredThe description cut to a few words, at most 50 characters, for a client to show on one line where the description would not fit.
kindRdsetDimensionKindrequiredTextEnumIdDateNumberCurrencyUnknownlookupRdsetLookuprequiredHow a person finds a value to filter on. Search means type part of a name into /report-datasets/{id}/dimension-values and pick from what comes back; an id is never typed by hand.
OwnValuesSearchNotFilterableByValueUnknownHow a value to filter on is found, by its subtype: a fixed set listed inline with each value's label, in the order a person picks from; the dimension's own values or a lookup's, searched through /report-datasets/{id}/dimension-values; typed by the person, with why; or none, for a dimension that cannot be filtered on.
typeTyped by the person: a number, a date or text with nothing to pick from.
reasonstringrequiredWhy nothing is offered to pick from, for a client to show beside the input.
Example Requested by the customer.
A fixed set: pick from options, in their order. /report-datasets/{id}/dimension-values answers the same options, narrowed by q to those whose value or label holds it, whatever its case.
typeenumrequiredRdsetOptionAttributesvaluestringrequiredThe value to send in a filter.
labelstringrequiredWhat a person reads for it.
namedPartRdsetDatePartFor a number that is a part of the time, which part, so a client reads a value as its label (is March, is Monday) rather than comparing a figure. Absent for any other set.
HourOfDayDayOfWeekDayOfMonthMonthOfYearUnknownThe dimension cannot be filtered on, so it takes no value.
The dimension cannot be filtered on, so it takes no value.
Ids of a record found by its name: read them from /report-datasets/{id}/dimension-values with part of the name in q, each id answered with its name where this caller may read it.
minimumSearchinteger (int32)requiredHow many characters of q the read needs.
Example 1250
The dimension's own stored values: read them from /report-datasets/{id}/dimension-values, by part of a value in q.
minimumSearchinteger (int32)requiredHow many characters of q the read needs. A read with no q is refused while the values are too many to list.
Example 1250
drillsTostringFor a tenancy level, enterprise, marketplace, merchant or customer, the dimension of the level beneath it, to drill into. Absent for the lowest level and for every other dimension.
matchesTextbooleanrequiredWhether an RqryFilterContains may search it for part of its text.
Example true
groupstringrequiredThe heading a client files it under beside the dataset's other dimensions, such as Tenancy, Time or Bands.
The rules a question grouping or filtering by it is held to.
typeA question with measures returns at most max rows, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A question asking it may ask, beside it, only measures.
measuresarray of stringIt takes at most max values, which a pivot column counts against RdsetRulePivotSize.
maxinteger (int32)requiredExample 1250
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
A question asking it may not hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question may not hold both parts.
firstRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
secondRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
An export holds at most max rows, and is refused rather than cut short when the answer holds more.
maxinteger (int32)requiredExample 1250
A filter on it is one of operators, each naming the RqryFilter subtype of that name; any other is refused.
operatorsarray of RdsetFilterOperatorEqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It is a share within dimensions, so a question asking it groups by each of them and never ranks one with a top.
dimensionsarray of stringA question groups by at most max dimensions.
maxinteger (int32)requiredExample 1250
A question holds at most max measure filters.
maxinteger (int32)requiredExample 1250
A range bucketed by this grain spans at most range, an ISO 8601 period such as P31D.
rangestringrequiredA question asking it must hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is money in the currency dimension holds, so a question asking it groups by that dimension or pins it with an RqryFilterEquals; in a pivot, or under a top ranking that dimension, it pins it.
dimensionstringrequiredIt divides money in the currency dimension holds, so a question asking it pins that dimension with an RqryFilterEquals.
dimensionstringrequiredA question asking it cannot group or filter by dimensions, each a band worked out per group.
dimensionsarray of stringAn RqryFilterContains cannot search it.
An RqryFilterContains cannot search it.
It cannot be filtered on, only grouped by or listed as a row column.
It cannot be filtered on, only grouped by or listed as a row column.
A question asking it cannot filter on dimensions; it may group by them.
dimensionsarray of stringA top cannot rank by it.
A top cannot rank by it.
It is a balance carried from each record's latest change, so a question asking it cannot group or filter by dimensions.
dimensionsarray of stringA measure filter cannot test it.
A measure filter cannot test it.
It is a balance observed by grain snapshots, so it cannot be bucketed by notByGrains or grouped by notByDimensions, whose buckets do not hold whole snapshots. It is summed across dimensions, never across time.
grainstringrequirednotByGrainsarray of stringnotByDimensionsarray of stringA question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A pivot's columns combine to at most maxColumnValues values, by each column dimension's RdsetRuleAtMostValues, and its rows, time and subtotals to at most maxGroupingSets grouping sets.
maxColumnValuesinteger (int32)requiredExample 1250
maxGroupingSetsinteger (int32)requiredExample 1250
The part names only dimensions the question groups by and measures it asks for; a pivot names each grouped dimension once.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question holding part must hold needs too.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
needsRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question with no measures returns at most max rows a page, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A top's count is from 1 to max.
maxinteger (int32)requiredExample 1250
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A filter value is a whole number from first to last; any other can never match.
firstinteger (int32)requiredExample 1250
lastinteger (int32)requiredExample 1250
operatorsarray of RdsetFilterOperatorThe filters it takes, each naming the RqryFilter subtype of that name. A number or a date is compared and ranged, text a person reads is searched, and anything filterable is matched by its values. Empty for a dimension that cannot be filtered on.
EqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
identifiesRdsetEntityKindThe record its values are the ids of, so a client links each value to that record through one mapping of kinds to pages. Absent for a dimension whose values identify nothing to open, a name or a row key among them.
EnterpriseMarketplaceMerchantCustomerPaymentLoanLoanStatementLoanTransactionLoanFacilityIssuerTransaction+5 moreShow fewer
Card, Ledger, LedgerEntry, Invoice, Unknown
For a band, its values in the order the bands climb, each with the tone a figure in it reads in, so a client colours a band by what it means rather than by its place. Empty for any other dimension.
typeenumrequiredRdsetStatusOutcomeAttributeslabelstringrequiredtoneRdsetStatusTonerequiredDangerWarningSuccessMutedNeutralUnknowncurrencyDimensionstringFor an amount of money, the dimension holding its currency on the same row, as a Money measure's currencyDimension does. A question lists it beside the amount for its answer to carry the currency. Absent for any other dimension.
Example AUD
typeenumrequiredRdsetMeasureAttributesnamestringrequiredExample Ada Lovelace
labelstringrequireddescriptionstringrequiredsummarystringrequiredThe description cut to a few words, at most 50 characters, for a client to show on one line where the description would not fit.
formatRdsetMeasureFormatrequiredMoneyPercentCountNumberTimestampUnknowncurrencyDimensionstringFor a Money measure, the dimension holding its currency. A query must group or pin that dimension.
Example AUD
currencystringFor a Money measure already in one currency, such as a converted one, that currency.
Example AUD
decimalsinteger (int32)requiredExample 1250
additivityRdsetMeasureAdditivityrequiredWhether a client may add the measure's figures up itself, across the rows of an answer.
AdditiveSemiAdditiveNonAdditiveUnknownWhat the measure is held to. An answer holding the measure carries, per row, its status against it. Absent for none.
typeBands, such as green, amber and red: a row's status is the label of the band its figure falls in.
labelstringrequiredtypeenumrequiredRdsetTargetBandAttributeslabelstringrequiredfromstringuntilstringA limit, such as a card scheme's dispute threshold: a row's figure Met it or Breached it. The value is a decimal as text.
labelstringrequiredvaluestringrequiredkindRdsetLimitKindrequiredAtMostAtLeastUnknowngroupstringrequiredThe heading a client files it under beside the dataset's other measures, such as Amounts, Counts or Balances.
The rules a question asking it is held to.
typeA question with measures returns at most max rows, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A question asking it may ask, beside it, only measures.
measuresarray of stringIt takes at most max values, which a pivot column counts against RdsetRulePivotSize.
maxinteger (int32)requiredExample 1250
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
A question asking it may not hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question may not hold both parts.
firstRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
secondRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
An export holds at most max rows, and is refused rather than cut short when the answer holds more.
maxinteger (int32)requiredExample 1250
A filter on it is one of operators, each naming the RqryFilter subtype of that name; any other is refused.
operatorsarray of RdsetFilterOperatorEqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It is a share within dimensions, so a question asking it groups by each of them and never ranks one with a top.
dimensionsarray of stringA question groups by at most max dimensions.
maxinteger (int32)requiredExample 1250
A question holds at most max measure filters.
maxinteger (int32)requiredExample 1250
A range bucketed by this grain spans at most range, an ISO 8601 period such as P31D.
rangestringrequiredA question asking it must hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is money in the currency dimension holds, so a question asking it groups by that dimension or pins it with an RqryFilterEquals; in a pivot, or under a top ranking that dimension, it pins it.
dimensionstringrequiredIt divides money in the currency dimension holds, so a question asking it pins that dimension with an RqryFilterEquals.
dimensionstringrequiredA question asking it cannot group or filter by dimensions, each a band worked out per group.
dimensionsarray of stringAn RqryFilterContains cannot search it.
An RqryFilterContains cannot search it.
It cannot be filtered on, only grouped by or listed as a row column.
It cannot be filtered on, only grouped by or listed as a row column.
A question asking it cannot filter on dimensions; it may group by them.
dimensionsarray of stringA top cannot rank by it.
A top cannot rank by it.
It is a balance carried from each record's latest change, so a question asking it cannot group or filter by dimensions.
dimensionsarray of stringA measure filter cannot test it.
A measure filter cannot test it.
It is a balance observed by grain snapshots, so it cannot be bucketed by notByGrains or grouped by notByDimensions, whose buckets do not hold whole snapshots. It is summed across dimensions, never across time.
grainstringrequirednotByGrainsarray of stringnotByDimensionsarray of stringA question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A pivot's columns combine to at most maxColumnValues values, by each column dimension's RdsetRuleAtMostValues, and its rows, time and subtotals to at most maxGroupingSets grouping sets.
maxColumnValuesinteger (int32)requiredExample 1250
maxGroupingSetsinteger (int32)requiredExample 1250
The part names only dimensions the question groups by and measures it asks for; a pivot names each grouped dimension once.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question holding part must hold needs too.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
needsRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question with no measures returns at most max rows a page, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A top's count is from 1 to max.
maxinteger (int32)requiredExample 1250
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A filter value is a whole number from first to last; any other can never match.
firstinteger (int32)requiredExample 1250
lastinteger (int32)requiredExample 1250
riseIsRchtRiseIsWhether a rise in it is good news, bad news or neither, which a client colours a change in it by wherever it is shown, a table's column as well as a single figure. Absent where the dataset does not say.
GoodBadNeutralUnknownrowColumnsarray of stringThe columns a query with no measures returns, one row per record. Empty when the dataset has no row mode.
suggestedChartsarray of RdsetChartBigNumberTimeSeriesBarPieTableUnknownNamed filters a question can apply by name, in segments.
typeenumrequiredRdsetSegmentAttributesnamestringrequiredExample Ada Lovelace
labelstringrequireddescriptionstringrequiredThe kinds of custom period the dataset is asked by, named in an RqryRangePeriod with the period's own bounds.
typeenumrequiredRdsetPeriodAttributesnamestringrequiredExample Ada Lovelace
labelstringrequireddescriptionstringrequiredtimezonestringrequiredThe timezone this caller's questions are answered in when they name none, an IANA name or an offset: the timezone every active merchant the caller reads keeps, or the dataset's where they keep several. It is the default over the caller's own scope; a question narrowed with narrowTo takes the default of the tenants it narrows to, which may differ. A question's timezone overrides it.
The rules every question of this dataset is held to. Each dimension, measure and grain carries the rules a question naming it is held to.
typeA question with measures returns at most max rows, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A question asking it may ask, beside it, only measures.
measuresarray of stringIt takes at most max values, which a pivot column counts against RdsetRulePivotSize.
maxinteger (int32)requiredExample 1250
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
An RqryFilterContains on it needs a time slice, to bound the rows it tests.
A question asking it may not hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question may not hold both parts.
firstRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
secondRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
An export holds at most max rows, and is refused rather than cut short when the answer holds more.
maxinteger (int32)requiredExample 1250
A filter on it is one of operators, each naming the RqryFilter subtype of that name; any other is refused.
operatorsarray of RdsetFilterOperatorEqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It has too many values to group by unbounded: grouping by it needs an RqryFilterEquals, RqryFilterIn, RqryFilterBetween or RqryFilterAbsent on it, a limit, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.
It is a share within dimensions, so a question asking it groups by each of them and never ranks one with a top.
dimensionsarray of stringA question groups by at most max dimensions.
maxinteger (int32)requiredExample 1250
A question holds at most max measure filters.
maxinteger (int32)requiredExample 1250
A range bucketed by this grain spans at most range, an ISO 8601 period such as P31D.
rangestringrequiredA question asking it must hold part.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.
It is money in the currency dimension holds, so a question asking it groups by that dimension or pins it with an RqryFilterEquals; in a pivot, or under a top ranking that dimension, it pins it.
dimensionstringrequiredIt divides money in the currency dimension holds, so a question asking it pins that dimension with an RqryFilterEquals.
dimensionstringrequiredA question asking it cannot group or filter by dimensions, each a band worked out per group.
dimensionsarray of stringAn RqryFilterContains cannot search it.
An RqryFilterContains cannot search it.
It cannot be filtered on, only grouped by or listed as a row column.
It cannot be filtered on, only grouped by or listed as a row column.
A question asking it cannot filter on dimensions; it may group by them.
dimensionsarray of stringA top cannot rank by it.
A top cannot rank by it.
It is a balance carried from each record's latest change, so a question asking it cannot group or filter by dimensions.
dimensionsarray of stringA measure filter cannot test it.
A measure filter cannot test it.
It is a balance observed by grain snapshots, so it cannot be bucketed by notByGrains or grouped by notByDimensions, whose buckets do not hold whole snapshots. It is summed across dimensions, never across time.
grainstringrequirednotByGrainsarray of stringnotByDimensionsarray of stringA question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.
A pivot's columns combine to at most maxColumnValues values, by each column dimension's RdsetRuleAtMostValues, and its rows, time and subtotals to at most maxGroupingSets grouping sets.
maxColumnValuesinteger (int32)requiredExample 1250
maxGroupingSetsinteger (int32)requiredExample 1250
The part names only dimensions the question groups by and measures it asks for; a pivot names each grouped dimension once.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question holding part must hold needs too.
partRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
needsRdsetQuestionPartrequiredPivotTopMeasureFilterComparisonAsAtTimeSlicePeriodRangeRowModeSortSortByTime+3 moreShow fewer
Page, Export, Unknown
A question with no measures returns at most max rows a page, and its limit is at most max.
maxinteger (int32)requiredExample 1250
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A filter value is one of its values from /report-datasets/{id}/dimension-values, never a range or part of its text. A marketplace also takes Direct.
A top's count is from 1 to max.
maxinteger (int32)requiredExample 1250
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A range ends after it starts and lies within the representable years, as does an asAt instant; a filter value fits its dimension's kind; an RqryFilterIn or RqryFilterNotIn names a value; and a page is one this question's answer returned.
A filter value is a whole number from first to last; any other can never match.
firstinteger (int32)requiredExample 1250
lastinteger (int32)requiredExample 1250
What a row of an answer is, read from several of its measures, such as a customer's credit status. An answer carries a RowStatus column for each status whose every measure the question asks. Only the statuses this caller may read every measure of are listed.
typeenumrequiredRdsetStatusAttributesnamestringrequiredExample Ada Lovelace
labelstringrequireddescriptionstringrequiredmeasuresarray of stringThe measures its rules test, every one of which a question asks for an answer to carry the status.
typeenumrequiredRdsetStatusRuleAttributeslabelstringrequiredtoneRdsetStatusTonerequiredHow the status reads to a person, so a client shades it without knowing the report.
DangerWarningSuccessMutedNeutralUnknownEvery test must pass for the rule to hold.
typeenumrequiredRdsetStatusTestAttributesmeasurestringrequiredcomparisonRdsetStatusComparisonrequiredAboveAtLeastBelowAtMostNotEqualUnknownvaluestringrequiredpassesAbsentbooleanrequiredWhether a row with no figure for the measure passes.
Example true
The status of a row no rule holds for. Absent for none.
typeenumrequiredRdsetStatusOutcomeAttributeslabelstringrequiredtoneRdsetStatusTonerequiredDangerWarningSuccessMutedNeutralUnknown{
"type": "RdsetAttributes",
"reportDatasetId": "string",
"domain": "string",
"label": "string",
"description": "string",
"grains": [
{
"type": "RdsetGrainAttributes",
"name": "Ada Lovelace",
"label": "string",
"rules": [
{
"type": "RdsetRuleAggregateLimit",
"max": 1250
}
]
}
],
"defaultGrain": "string",
"dimensions": [
{
"type": "RdsetDimensionAttributes",
"name": "Ada Lovelace",
"label": "string",
"description": "string",
"summary": "string",
"kind": "Text",
"lookup": "OwnValues",
"values": {
"type": "RdsetValuesEntered",
"reason": "Requested by the customer."
},
"drillsTo": "string",
"matchesText": true,
"group": "string",
"rules": [
{
"type": "RdsetRuleAggregateLimit",
"max": 1250
}
],
"operators": [
"Equals"
],
"identifies": "Enterprise",
"bands": [
{
"type": "RdsetStatusOutcomeAttributes",
"label": "string",
"tone": "Danger"
}
],
"currencyDimension": "AUD"
}
],
"measures": [
{
"type": "RdsetMeasureAttributes",
"name": "Ada Lovelace",
"label": "string",
"description": "string",
"summary": "string",
"format": "Money",
"currencyDimension": "AUD",
"currency": "AUD",
"decimals": 1250,
"additivity": "Additive",
"target": {
"type": "RdsetTargetBands",
"label": "string",
"bands": [
{
"type": "RdsetTargetBandAttributes",
"label": "string",
"from": "string",
"until": "string"
}
]
},
"group": "string",
"rules": [
{
"type": "RdsetRuleAggregateLimit",
"max": 1250
}
],
"riseIs": "Good"
}
],
"rowColumns": [
"string"
],
"suggestedCharts": [
"BigNumber"
],
"segments": [
{
"type": "RdsetSegmentAttributes",
"name": "Ada Lovelace",
"label": "string",
"description": "string"
}
],
"periods": [
{
"type": "RdsetPeriodAttributes",
"name": "Ada Lovelace",
"label": "string",
"description": "string"
}
],
"timezone": "string",
"rules": [
{
"type": "RdsetRuleAggregateLimit",
"max": 1250
}
],
"statuses": [
{
"type": "RdsetStatusAttributes",
"name": "Ada Lovelace",
"label": "string",
"description": "string",
"measures": [
"string"
],
"rules": [
{
"type": "RdsetStatusRuleAttributes",
"label": "string",
"tone": "Danger",
"tests": [
{
"type": "RdsetStatusTestAttributes",
"measure": "string",
"comparison": "Above",
"value": "string",
"passesAbsent": true
}
]
}
],
"otherwise": {
"type": "RdsetStatusOutcomeAttributes",
"label": "string",
"tone": "Danger"
}
}
]
}Error responses
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}