@@ -1762,6 +1762,179 @@ components:
17621762 oneOf:
17631763 - $ref: '#/components/schemas/AWSIntegrationUpdate'
17641764 - $ref: '#/components/schemas/HTTPIntegrationUpdate'
1765+ ActionQuery:
1766+ description: An action query. This query type is used to trigger an action,
1767+ such as sending a HTTP request.
1768+ properties:
1769+ events:
1770+ description: Events to listen for downstream of the action query.
1771+ items:
1772+ $ref: '#/components/schemas/AppBuilderEvent'
1773+ type: array
1774+ id:
1775+ description: The ID of the action query.
1776+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1777+ format: uuid
1778+ type: string
1779+ name:
1780+ description: A unique identifier for this action query. This name is also
1781+ used to access the query's result throughout the app.
1782+ example: fetchPendingOrders
1783+ type: string
1784+ properties:
1785+ $ref: '#/components/schemas/ActionQueryProperties'
1786+ type:
1787+ $ref: '#/components/schemas/ActionQueryType'
1788+ required:
1789+ - id
1790+ - name
1791+ - type
1792+ - properties
1793+ type: object
1794+ ActionQueryCondition:
1795+ description: Whether to run this query. If specified, the query will only run
1796+ if this condition evaluates to `true` in JavaScript and all other conditions
1797+ are also met.
1798+ oneOf:
1799+ - type: boolean
1800+ - example: ${true}
1801+ type: string
1802+ ActionQueryDebounceInMs:
1803+ description: The minimum time in milliseconds that must pass before the query
1804+ can be triggered again. This is useful for preventing accidental double-clicks
1805+ from triggering the query multiple times.
1806+ oneOf:
1807+ - example: 1000
1808+ format: int64
1809+ type: integer
1810+ - example: 31.5
1811+ format: double
1812+ type: integer
1813+ - description: If this is a string, it must be a valid JavaScript expression
1814+ that evaluates to a number.
1815+ example: ${1000}
1816+ type: string
1817+ ActionQueryMockedOutputs:
1818+ description: The mocked outputs of the action query. This is useful for testing
1819+ the app without actually running the action.
1820+ oneOf:
1821+ - type: string
1822+ - properties:
1823+ enabled:
1824+ $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
1825+ outputs:
1826+ description: The mocked outputs of the action query, serialized as JSON.
1827+ example: '{"status": "success"}'
1828+ type: string
1829+ required:
1830+ - enabled
1831+ type: object
1832+ ActionQueryMockedOutputsEnabled:
1833+ description: Whether to enable the mocked outputs for testing.
1834+ oneOf:
1835+ - type: boolean
1836+ - description: If this is a string, it must be a valid JavaScript expression
1837+ that evaluates to a boolean.
1838+ example: ${true}
1839+ type: string
1840+ ActionQueryOnlyTriggerManually:
1841+ description: Determines when this query is executed. If set to `false`, the
1842+ query will run when the app loads and whenever any query arguments change.
1843+ If set to `true`, the query will only run when manually triggered from elsewhere
1844+ in the app.
1845+ oneOf:
1846+ - type: boolean
1847+ - description: If this is a string, it must be a valid JavaScript expression
1848+ that evaluates to a boolean.
1849+ example: ${true}
1850+ type: string
1851+ ActionQueryPollingIntervalInMs:
1852+ description: If specified, the app will poll the query at the specified interval
1853+ in milliseconds. The minimum polling interval is 15 seconds. The query will
1854+ only poll when the app's browser tab is active.
1855+ oneOf:
1856+ - example: 15000
1857+ format: int64
1858+ minimum: 15000
1859+ type: integer
1860+ - example: 19500.0
1861+ format: double
1862+ minimum: 15000.0
1863+ type: integer
1864+ - description: If this is a string, it must be a valid JavaScript expression
1865+ that evaluates to a number.
1866+ example: ${15000}
1867+ type: string
1868+ ActionQueryProperties:
1869+ description: The properties of the action query.
1870+ properties:
1871+ condition:
1872+ $ref: '#/components/schemas/ActionQueryCondition'
1873+ debounceInMs:
1874+ $ref: '#/components/schemas/ActionQueryDebounceInMs'
1875+ mockedOutputs:
1876+ $ref: '#/components/schemas/ActionQueryMockedOutputs'
1877+ onlyTriggerManually:
1878+ $ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
1879+ pollingIntervalInMs:
1880+ $ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
1881+ requiresConfirmation:
1882+ $ref: '#/components/schemas/ActionQueryRequiresConfirmation'
1883+ showToastOnError:
1884+ $ref: '#/components/schemas/ActionQueryShowToastOnError'
1885+ spec:
1886+ $ref: '#/components/schemas/ActionQuerySpec'
1887+ type: object
1888+ ActionQueryRequiresConfirmation:
1889+ description: Whether to prompt the user to confirm this query before it runs.
1890+ oneOf:
1891+ - type: boolean
1892+ - description: If this is a string, it must be a valid JavaScript expression
1893+ that evaluates to a boolean.
1894+ example: ${true}
1895+ type: string
1896+ ActionQueryShowToastOnError:
1897+ description: Whether to display a toast to the user when the query returns an
1898+ error.
1899+ oneOf:
1900+ - type: boolean
1901+ - description: If this is a string, it must be a valid JavaScript expression
1902+ that evaluates to a boolean.
1903+ example: ${true}
1904+ type: string
1905+ ActionQuerySpec:
1906+ description: The definition of the action query.
1907+ oneOf:
1908+ - type: string
1909+ - properties:
1910+ connectionId:
1911+ description: The ID of the custom connection to use for this action query.
1912+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1913+ format: uuid
1914+ type: string
1915+ fqn:
1916+ description: The fully qualified name of the action type.
1917+ example: com.datadoghq.http.request
1918+ type: string
1919+ inputs:
1920+ $ref: '#/components/schemas/ActionQuerySpecInputs'
1921+ type: object
1922+ ActionQuerySpecInputs:
1923+ description: The inputs to the action query. These are the values that are passed
1924+ to the action when it is triggered.
1925+ oneOf:
1926+ - type: string
1927+ - additionalProperties: {}
1928+ type: object
1929+ ActionQueryType:
1930+ default: action
1931+ description: The action query type.
1932+ enum:
1933+ - action
1934+ example: action
1935+ type: string
1936+ x-enum-varnames:
1937+ - ACTION
17651938 ActiveBillingDimensionsAttributes:
17661939 description: List of active billing dimensions.
17671940 properties:
@@ -9218,6 +9391,48 @@ components:
92189391 type: number
92199392 type: array
92209393 type: object
9394+ DataTransform:
9395+ description: A data transformer, which is custom JavaScript code that executes
9396+ and transforms data when its inputs change.
9397+ properties:
9398+ id:
9399+ description: The ID of the data transformer.
9400+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
9401+ format: uuid
9402+ type: string
9403+ name:
9404+ description: A unique identifier for this data transformer. This name is
9405+ also used to access the transformer's result throughout the app.
9406+ example: combineTwoOrders
9407+ type: string
9408+ properties:
9409+ $ref: '#/components/schemas/DataTransformProperties'
9410+ type:
9411+ $ref: '#/components/schemas/DataTransformType'
9412+ required:
9413+ - id
9414+ - name
9415+ - type
9416+ - properties
9417+ type: object
9418+ DataTransformProperties:
9419+ description: The properties of the data transformer.
9420+ properties:
9421+ outputs:
9422+ description: A JavaScript function that returns the transformed data.
9423+ example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items,
9424+ ...fetchOrder2.outputs.items],\n}})()}"
9425+ type: string
9426+ type: object
9427+ DataTransformType:
9428+ default: dataTransform
9429+ description: The data transform type.
9430+ enum:
9431+ - dataTransform
9432+ example: dataTransform
9433+ type: string
9434+ x-enum-varnames:
9435+ - DATATRANSFORM
92219436 Date:
92229437 description: Date as Unix timestamp in milliseconds.
92239438 example: 1722439510282
@@ -21098,34 +21313,12 @@ components:
2109821313 $ref: '#/components/schemas/Deployment'
2109921314 type: object
2110021315 Query:
21101- description: A query used by an app. This can take the form of an external action,
21102- a data transformation, or a state variable change.
21103- properties:
21104- events:
21105- description: Events to listen for downstream of the query.
21106- items:
21107- $ref: '#/components/schemas/AppBuilderEvent'
21108- type: array
21109- id:
21110- description: The ID of the query.
21111- example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
21112- format: uuid
21113- type: string
21114- name:
21115- description: The name of the query. The name must be unique within the app
21116- and is visible in the app editor.
21117- example: ''
21118- type: string
21119- properties:
21120- description: The properties of the query. The properties vary depending
21121- on the query type.
21122- type:
21123- $ref: '#/components/schemas/QueryType'
21124- required:
21125- - id
21126- - name
21127- - type
21128- type: object
21316+ description: A data query used by an app. This can take the form of an external
21317+ action, a data transformation, or a state variable.
21318+ oneOf:
21319+ - $ref: '#/components/schemas/ActionQuery'
21320+ - $ref: '#/components/schemas/DataTransform'
21321+ - $ref: '#/components/schemas/StateVariable'
2112921322 QueryFormula:
2113021323 description: A formula for calculation based on one or more queries.
2113121324 properties:
@@ -21149,18 +21342,6 @@ components:
2114921342 x-enum-varnames:
2115021343 - ASC
2115121344 - DESC
21152- QueryType:
21153- description: The query type.
21154- enum:
21155- - action
21156- - stateVariable
21157- - dataTransform
21158- example: action
21159- type: string
21160- x-enum-varnames:
21161- - ACTION
21162- - STATEVARIABLE
21163- - DATATRANSFORM
2116421345 RUMAggregateBucketValue:
2116521346 description: A bucket value, can be either a timeseries or a single value.
2116621347 oneOf:
@@ -28831,6 +29012,46 @@ components:
2883129012 - PASS
2883229013 - FAIL
2883329014 - SKIP
29015+ StateVariable:
29016+ description: A variable, which can be set and read by other components in the
29017+ app.
29018+ properties:
29019+ id:
29020+ description: The ID of the state variable.
29021+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
29022+ format: uuid
29023+ type: string
29024+ name:
29025+ description: A unique identifier for this state variable. This name is also
29026+ used to access the variable's value throughout the app.
29027+ example: ordersToSubmit
29028+ type: string
29029+ properties:
29030+ $ref: '#/components/schemas/StateVariableProperties'
29031+ type:
29032+ $ref: '#/components/schemas/StateVariableType'
29033+ required:
29034+ - id
29035+ - name
29036+ - type
29037+ - properties
29038+ type: object
29039+ StateVariableProperties:
29040+ description: The properties of the state variable.
29041+ properties:
29042+ defaultValue:
29043+ description: The default value of the state variable.
29044+ example: ${['order_3145', 'order_4920']}
29045+ type: object
29046+ StateVariableType:
29047+ default: stateVariable
29048+ description: The state variable type.
29049+ enum:
29050+ - stateVariable
29051+ example: stateVariable
29052+ type: string
29053+ x-enum-varnames:
29054+ - STATEVARIABLE
2883429055 TagsEventAttribute:
2883529056 description: Array of tags associated with your event.
2883629057 example:
@@ -32519,6 +32740,12 @@ paths:
3251932740 schema:
3252032741 $ref: '#/components/schemas/JSONAPIErrorResponse'
3252132742 description: Not Found
32743+ '410':
32744+ content:
32745+ application/json:
32746+ schema:
32747+ $ref: '#/components/schemas/JSONAPIErrorResponse'
32748+ description: Gone
3252232749 '429':
3252332750 $ref: '#/components/responses/TooManyRequestsResponse'
3252432751 summary: Get App
0 commit comments