@@ -1762,6 +1762,177 @@ 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+ - properties:
1820+ enabled:
1821+ $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
1822+ outputs:
1823+ description: The mocked outputs of the action query, serialized as JSON.
1824+ example: '{"status": "success"}'
1825+ type: string
1826+ required:
1827+ - enabled
1828+ type: object
1829+ ActionQueryMockedOutputsEnabled:
1830+ description: Whether to enable the mocked outputs for testing.
1831+ oneOf:
1832+ - type: boolean
1833+ - description: If this is a string, it must be a valid JavaScript expression
1834+ that evaluates to a boolean.
1835+ example: ${true}
1836+ type: string
1837+ ActionQueryOnlyTriggerManually:
1838+ description: Determines when this query is executed. If set to `false`, the
1839+ query will run when the app loads and whenever any query arguments change.
1840+ If set to `true`, the query will only run when manually triggered from elsewhere
1841+ in the app.
1842+ oneOf:
1843+ - type: boolean
1844+ - description: If this is a string, it must be a valid JavaScript expression
1845+ that evaluates to a boolean.
1846+ example: ${true}
1847+ type: string
1848+ ActionQueryPollingIntervalInMs:
1849+ description: If specified, the app will poll the query at the specified interval
1850+ in milliseconds. The minimum polling interval is 15 seconds. The query will
1851+ only poll when the app's browser tab is active.
1852+ oneOf:
1853+ - example: 30000.0
1854+ format: double
1855+ minimum: 15000.0
1856+ type: number
1857+ - description: If this is a string, it must be a valid JavaScript expression
1858+ that evaluates to a number.
1859+ example: ${15000}
1860+ type: string
1861+ ActionQueryProperties:
1862+ description: The properties of the action query.
1863+ properties:
1864+ condition:
1865+ $ref: '#/components/schemas/ActionQueryCondition'
1866+ debounceInMs:
1867+ $ref: '#/components/schemas/ActionQueryDebounceInMs'
1868+ mockedOutputs:
1869+ $ref: '#/components/schemas/ActionQueryMockedOutputs'
1870+ onlyTriggerManually:
1871+ $ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
1872+ pollingIntervalInMs:
1873+ $ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
1874+ requiresConfirmation:
1875+ $ref: '#/components/schemas/ActionQueryRequiresConfirmation'
1876+ showToastOnError:
1877+ $ref: '#/components/schemas/ActionQueryShowToastOnError'
1878+ spec:
1879+ $ref: '#/components/schemas/ActionQuerySpec'
1880+ required:
1881+ - spec
1882+ type: object
1883+ ActionQueryRequiresConfirmation:
1884+ description: Whether to prompt the user to confirm this query before it runs.
1885+ oneOf:
1886+ - type: boolean
1887+ - description: If this is a string, it must be a valid JavaScript expression
1888+ that evaluates to a boolean.
1889+ example: ${true}
1890+ type: string
1891+ ActionQueryShowToastOnError:
1892+ description: Whether to display a toast to the user when the query returns an
1893+ error.
1894+ oneOf:
1895+ - type: boolean
1896+ - description: If this is a string, it must be a valid JavaScript expression
1897+ that evaluates to a boolean.
1898+ example: ${true}
1899+ type: string
1900+ ActionQuerySpec:
1901+ description: The definition of the action query.
1902+ oneOf:
1903+ - type: string
1904+ - properties:
1905+ connectionId:
1906+ description: The ID of the custom connection to use for this action query.
1907+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1908+ format: uuid
1909+ type: string
1910+ fqn:
1911+ description: The fully qualified name of the action type.
1912+ example: com.datadoghq.http.request
1913+ type: string
1914+ inputs:
1915+ $ref: '#/components/schemas/ActionQuerySpecInputs'
1916+ required:
1917+ - fqn
1918+ - connectionId
1919+ type: object
1920+ ActionQuerySpecInputs:
1921+ description: The inputs to the action query. These are the values that are passed
1922+ to the action when it is triggered.
1923+ oneOf:
1924+ - type: string
1925+ - additionalProperties: {}
1926+ type: object
1927+ ActionQueryType:
1928+ default: action
1929+ description: The action query type.
1930+ enum:
1931+ - action
1932+ example: action
1933+ type: string
1934+ x-enum-varnames:
1935+ - ACTION
17651936 ActiveBillingDimensionsAttributes:
17661937 description: List of active billing dimensions.
17671938 properties:
@@ -9218,6 +9389,48 @@ components:
92189389 type: number
92199390 type: array
92209391 type: object
9392+ DataTransform:
9393+ description: A data transformer, which is custom JavaScript code that executes
9394+ and transforms data when its inputs change.
9395+ properties:
9396+ id:
9397+ description: The ID of the data transformer.
9398+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
9399+ format: uuid
9400+ type: string
9401+ name:
9402+ description: A unique identifier for this data transformer. This name is
9403+ also used to access the transformer's result throughout the app.
9404+ example: combineTwoOrders
9405+ type: string
9406+ properties:
9407+ $ref: '#/components/schemas/DataTransformProperties'
9408+ type:
9409+ $ref: '#/components/schemas/DataTransformType'
9410+ required:
9411+ - id
9412+ - name
9413+ - type
9414+ - properties
9415+ type: object
9416+ DataTransformProperties:
9417+ description: The properties of the data transformer.
9418+ properties:
9419+ outputs:
9420+ description: A JavaScript function that returns the transformed data.
9421+ example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items,
9422+ ...fetchOrder2.outputs.items],\n}})()}"
9423+ type: string
9424+ type: object
9425+ DataTransformType:
9426+ default: dataTransform
9427+ description: The data transform type.
9428+ enum:
9429+ - dataTransform
9430+ example: dataTransform
9431+ type: string
9432+ x-enum-varnames:
9433+ - DATATRANSFORM
92219434 Date:
92229435 description: Date as Unix timestamp in milliseconds.
92239436 example: 1722439510282
@@ -21098,34 +21311,12 @@ components:
2109821311 $ref: '#/components/schemas/Deployment'
2109921312 type: object
2110021313 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
21314+ description: A data query used by an app. This can take the form of an external
21315+ action, a data transformation, or a state variable.
21316+ oneOf:
21317+ - $ref: '#/components/schemas/ActionQuery'
21318+ - $ref: '#/components/schemas/DataTransform'
21319+ - $ref: '#/components/schemas/StateVariable'
2112921320 QueryFormula:
2113021321 description: A formula for calculation based on one or more queries.
2113121322 properties:
@@ -21149,18 +21340,6 @@ components:
2114921340 x-enum-varnames:
2115021341 - ASC
2115121342 - 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
2116421343 RUMAggregateBucketValue:
2116521344 description: A bucket value, can be either a timeseries or a single value.
2116621345 oneOf:
@@ -28831,6 +29010,46 @@ components:
2883129010 - PASS
2883229011 - FAIL
2883329012 - SKIP
29013+ StateVariable:
29014+ description: A variable, which can be set and read by other components in the
29015+ app.
29016+ properties:
29017+ id:
29018+ description: The ID of the state variable.
29019+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
29020+ format: uuid
29021+ type: string
29022+ name:
29023+ description: A unique identifier for this state variable. This name is also
29024+ used to access the variable's value throughout the app.
29025+ example: ordersToSubmit
29026+ type: string
29027+ properties:
29028+ $ref: '#/components/schemas/StateVariableProperties'
29029+ type:
29030+ $ref: '#/components/schemas/StateVariableType'
29031+ required:
29032+ - id
29033+ - name
29034+ - type
29035+ - properties
29036+ type: object
29037+ StateVariableProperties:
29038+ description: The properties of the state variable.
29039+ properties:
29040+ defaultValue:
29041+ description: The default value of the state variable.
29042+ example: ${['order_3145', 'order_4920']}
29043+ type: object
29044+ StateVariableType:
29045+ default: stateVariable
29046+ description: The state variable type.
29047+ enum:
29048+ - stateVariable
29049+ example: stateVariable
29050+ type: string
29051+ x-enum-varnames:
29052+ - STATEVARIABLE
2883429053 TagsEventAttribute:
2883529054 description: Array of tags associated with your event.
2883629055 example:
@@ -32519,6 +32738,12 @@ paths:
3251932738 schema:
3252032739 $ref: '#/components/schemas/JSONAPIErrorResponse'
3252132740 description: Not Found
32741+ '410':
32742+ content:
32743+ application/json:
32744+ schema:
32745+ $ref: '#/components/schemas/JSONAPIErrorResponse'
32746+ description: Gone
3252232747 '429':
3252332748 $ref: '#/components/responses/TooManyRequestsResponse'
3252432749 summary: Get App
0 commit comments