@@ -1762,6 +1762,183 @@ 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: 310.5
1808+ format: double
1809+ type: number
1810+ - description: If this is a string, it must be a valid JavaScript expression
1811+ that evaluates to a number.
1812+ example: ${1000}
1813+ type: string
1814+ ActionQueryMockedOutputs:
1815+ description: The mocked outputs of the action query. This is useful for testing
1816+ the app without actually running the action.
1817+ oneOf:
1818+ - type: string
1819+ - $ref: '#/components/schemas/ActionQueryMockedOutputsObject'
1820+ ActionQueryMockedOutputsEnabled:
1821+ description: Whether to enable the mocked outputs for testing.
1822+ oneOf:
1823+ - type: boolean
1824+ - description: If this is a string, it must be a valid JavaScript expression
1825+ that evaluates to a boolean.
1826+ example: ${true}
1827+ type: string
1828+ ActionQueryMockedOutputsObject:
1829+ description: The mocked outputs of the action query.
1830+ properties:
1831+ enabled:
1832+ $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
1833+ outputs:
1834+ description: The mocked outputs of the action query, serialized as JSON.
1835+ example: '{"status": "success"}'
1836+ type: string
1837+ required:
1838+ - enabled
1839+ type: object
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: 30000.0
1857+ format: double
1858+ minimum: 15000.0
1859+ type: number
1860+ - description: If this is a string, it must be a valid JavaScript expression
1861+ that evaluates to a number.
1862+ example: ${15000}
1863+ type: string
1864+ ActionQueryProperties:
1865+ description: The properties of the action query.
1866+ properties:
1867+ condition:
1868+ $ref: '#/components/schemas/ActionQueryCondition'
1869+ debounceInMs:
1870+ $ref: '#/components/schemas/ActionQueryDebounceInMs'
1871+ mockedOutputs:
1872+ $ref: '#/components/schemas/ActionQueryMockedOutputs'
1873+ onlyTriggerManually:
1874+ $ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
1875+ pollingIntervalInMs:
1876+ $ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
1877+ requiresConfirmation:
1878+ $ref: '#/components/schemas/ActionQueryRequiresConfirmation'
1879+ showToastOnError:
1880+ $ref: '#/components/schemas/ActionQueryShowToastOnError'
1881+ spec:
1882+ $ref: '#/components/schemas/ActionQuerySpec'
1883+ required:
1884+ - spec
1885+ type: object
1886+ ActionQueryRequiresConfirmation:
1887+ description: Whether to prompt the user to confirm this query before it runs.
1888+ oneOf:
1889+ - type: boolean
1890+ - description: If this is a string, it must be a valid JavaScript expression
1891+ that evaluates to a boolean.
1892+ example: ${true}
1893+ type: string
1894+ ActionQueryShowToastOnError:
1895+ description: Whether to display a toast to the user when the query returns an
1896+ error.
1897+ oneOf:
1898+ - type: boolean
1899+ - description: If this is a string, it must be a valid JavaScript expression
1900+ that evaluates to a boolean.
1901+ example: ${true}
1902+ type: string
1903+ ActionQuerySpec:
1904+ description: The definition of the action query.
1905+ oneOf:
1906+ - type: string
1907+ - $ref: '#/components/schemas/ActionQuerySpecObject'
1908+ ActionQuerySpecInputs:
1909+ description: The inputs to the action query. These are the values that are passed
1910+ to the action when it is triggered.
1911+ oneOf:
1912+ - type: string
1913+ - additionalProperties: {}
1914+ type: object
1915+ ActionQuerySpecObject:
1916+ description: The action query spec object.
1917+ properties:
1918+ connectionId:
1919+ description: The ID of the custom connection to use for this action query.
1920+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1921+ format: uuid
1922+ type: string
1923+ fqn:
1924+ description: The fully qualified name of the action type.
1925+ example: com.datadoghq.http.request
1926+ type: string
1927+ inputs:
1928+ $ref: '#/components/schemas/ActionQuerySpecInputs'
1929+ required:
1930+ - fqn
1931+ - connectionId
1932+ type: object
1933+ ActionQueryType:
1934+ default: action
1935+ description: The action query type.
1936+ enum:
1937+ - action
1938+ example: action
1939+ type: string
1940+ x-enum-varnames:
1941+ - ACTION
17651942 ActiveBillingDimensionsAttributes:
17661943 description: List of active billing dimensions.
17671944 properties:
@@ -9218,6 +9395,48 @@ components:
92189395 type: number
92199396 type: array
92209397 type: object
9398+ DataTransform:
9399+ description: A data transformer, which is custom JavaScript code that executes
9400+ and transforms data when its inputs change.
9401+ properties:
9402+ id:
9403+ description: The ID of the data transformer.
9404+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
9405+ format: uuid
9406+ type: string
9407+ name:
9408+ description: A unique identifier for this data transformer. This name is
9409+ also used to access the transformer's result throughout the app.
9410+ example: combineTwoOrders
9411+ type: string
9412+ properties:
9413+ $ref: '#/components/schemas/DataTransformProperties'
9414+ type:
9415+ $ref: '#/components/schemas/DataTransformType'
9416+ required:
9417+ - id
9418+ - name
9419+ - type
9420+ - properties
9421+ type: object
9422+ DataTransformProperties:
9423+ description: The properties of the data transformer.
9424+ properties:
9425+ outputs:
9426+ description: A JavaScript function that returns the transformed data.
9427+ example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items,
9428+ ...fetchOrder2.outputs.items],\n}})()}"
9429+ type: string
9430+ type: object
9431+ DataTransformType:
9432+ default: dataTransform
9433+ description: The data transform type.
9434+ enum:
9435+ - dataTransform
9436+ example: dataTransform
9437+ type: string
9438+ x-enum-varnames:
9439+ - DATATRANSFORM
92219440 Date:
92229441 description: Date as Unix timestamp in milliseconds.
92239442 example: 1722439510282
@@ -21098,34 +21317,12 @@ components:
2109821317 $ref: '#/components/schemas/Deployment'
2109921318 type: object
2110021319 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
21320+ description: A data query used by an app. This can take the form of an external
21321+ action, a data transformation, or a state variable.
21322+ oneOf:
21323+ - $ref: '#/components/schemas/ActionQuery'
21324+ - $ref: '#/components/schemas/DataTransform'
21325+ - $ref: '#/components/schemas/StateVariable'
2112921326 QueryFormula:
2113021327 description: A formula for calculation based on one or more queries.
2113121328 properties:
@@ -21149,18 +21346,6 @@ components:
2114921346 x-enum-varnames:
2115021347 - ASC
2115121348 - 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
2116421349 RUMAggregateBucketValue:
2116521350 description: A bucket value, can be either a timeseries or a single value.
2116621351 oneOf:
@@ -28831,6 +29016,46 @@ components:
2883129016 - PASS
2883229017 - FAIL
2883329018 - SKIP
29019+ StateVariable:
29020+ description: A variable, which can be set and read by other components in the
29021+ app.
29022+ properties:
29023+ id:
29024+ description: The ID of the state variable.
29025+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
29026+ format: uuid
29027+ type: string
29028+ name:
29029+ description: A unique identifier for this state variable. This name is also
29030+ used to access the variable's value throughout the app.
29031+ example: ordersToSubmit
29032+ type: string
29033+ properties:
29034+ $ref: '#/components/schemas/StateVariableProperties'
29035+ type:
29036+ $ref: '#/components/schemas/StateVariableType'
29037+ required:
29038+ - id
29039+ - name
29040+ - type
29041+ - properties
29042+ type: object
29043+ StateVariableProperties:
29044+ description: The properties of the state variable.
29045+ properties:
29046+ defaultValue:
29047+ description: The default value of the state variable.
29048+ example: ${['order_3145', 'order_4920']}
29049+ type: object
29050+ StateVariableType:
29051+ default: stateVariable
29052+ description: The state variable type.
29053+ enum:
29054+ - stateVariable
29055+ example: stateVariable
29056+ type: string
29057+ x-enum-varnames:
29058+ - STATEVARIABLE
2883429059 TagsEventAttribute:
2883529060 description: Array of tags associated with your event.
2883629061 example:
@@ -32519,6 +32744,12 @@ paths:
3251932744 schema:
3252032745 $ref: '#/components/schemas/JSONAPIErrorResponse'
3252132746 description: Not Found
32747+ '410':
32748+ content:
32749+ application/json:
32750+ schema:
32751+ $ref: '#/components/schemas/JSONAPIErrorResponse'
32752+ description: Gone
3252232753 '429':
3252332754 $ref: '#/components/responses/TooManyRequestsResponse'
3252432755 summary: Get App
0 commit comments