@@ -4501,6 +4501,184 @@ components:
4501
4501
x-enum-varnames :
4502
4502
- ASC
4503
4503
- DESC
4504
+ RUMAggregateBucketValue :
4505
+ description : A bucket value, can be either a timeseries or a single value.
4506
+ oneOf :
4507
+ - $ref : ' #/components/schemas/RUMAggregateBucketValueSingleString'
4508
+ - $ref : ' #/components/schemas/RUMAggregateBucketValueSingleNumber'
4509
+ - $ref : ' #/components/schemas/RUMAggregateBucketValueTimeseries'
4510
+ RUMAggregateBucketValueSingleNumber :
4511
+ description : A single number value.
4512
+ format : double
4513
+ type : number
4514
+ RUMAggregateBucketValueSingleString :
4515
+ description : A single string value.
4516
+ type : string
4517
+ RUMAggregateBucketValueTimeseries :
4518
+ description : A timeseries array.
4519
+ items :
4520
+ $ref : ' #/components/schemas/RUMAggregateBucketValueTimeseriesPoint'
4521
+ type : array
4522
+ x-generate-alias-as-model : true
4523
+ RUMAggregateBucketValueTimeseriesPoint :
4524
+ description : A timeseries point.
4525
+ properties :
4526
+ time :
4527
+ description : The time value for this point.
4528
+ example : ' 2020-06-08T11:55:00.123Z'
4529
+ format : date-time
4530
+ type : string
4531
+ value :
4532
+ description : The value for this point.
4533
+ example : 19
4534
+ format : double
4535
+ type : number
4536
+ type : object
4537
+ RUMAggregateRequest :
4538
+ description : The object sent with the request to retrieve aggregation buckets
4539
+ of RUM events from your organization.
4540
+ properties :
4541
+ compute :
4542
+ description : The list of metrics or timeseries to compute for the retrieved
4543
+ buckets.
4544
+ items :
4545
+ $ref : ' #/components/schemas/RUMCompute'
4546
+ type : array
4547
+ filter :
4548
+ $ref : ' #/components/schemas/RUMQueryFilter'
4549
+ group_by :
4550
+ description : The rules for the group by.
4551
+ items :
4552
+ $ref : ' #/components/schemas/RUMGroupBy'
4553
+ type : array
4554
+ options :
4555
+ $ref : ' #/components/schemas/RUMQueryOptions'
4556
+ page :
4557
+ $ref : ' #/components/schemas/RUMQueryPageOptions'
4558
+ type : object
4559
+ RUMAggregateSort :
4560
+ description : A sort rule.
4561
+ example :
4562
+ aggregation : count
4563
+ order : asc
4564
+ properties :
4565
+ aggregation :
4566
+ $ref : ' #/components/schemas/RUMAggregationFunction'
4567
+ metric :
4568
+ description : The metric to sort by (only used for `type=measure`).
4569
+ example : ' @duration'
4570
+ type : string
4571
+ order :
4572
+ $ref : ' #/components/schemas/RUMSortOrder'
4573
+ type :
4574
+ $ref : ' #/components/schemas/RUMAggregateSortType'
4575
+ type : object
4576
+ RUMAggregateSortType :
4577
+ default : alphabetical
4578
+ description : The type of sorting algorithm.
4579
+ enum :
4580
+ - alphabetical
4581
+ - measure
4582
+ type : string
4583
+ x-enum-varnames :
4584
+ - ALPHABETICAL
4585
+ - MEASURE
4586
+ RUMAggregationBucketsResponse :
4587
+ description : The query results.
4588
+ properties :
4589
+ buckets :
4590
+ description : The list of matching buckets, one item per bucket.
4591
+ items :
4592
+ $ref : ' #/components/schemas/RUMBucketResponse'
4593
+ type : array
4594
+ type : object
4595
+ RUMAggregationFunction :
4596
+ description : An aggregation function.
4597
+ enum :
4598
+ - count
4599
+ - cardinality
4600
+ - pc75
4601
+ - pc90
4602
+ - pc95
4603
+ - pc98
4604
+ - pc99
4605
+ - sum
4606
+ - min
4607
+ - max
4608
+ - avg
4609
+ example : pc90
4610
+ type : string
4611
+ x-enum-varnames :
4612
+ - COUNT
4613
+ - CARDINALITY
4614
+ - PERCENTILE_75
4615
+ - PERCENTILE_90
4616
+ - PERCENTILE_95
4617
+ - PERCENTILE_98
4618
+ - PERCENTILE_99
4619
+ - SUM
4620
+ - MIN
4621
+ - MAX
4622
+ - AVG
4623
+ RUMAnalyticsAggregateResponse :
4624
+ description : The response object for the RUM events aggregate API endpoint.
4625
+ properties :
4626
+ data :
4627
+ $ref : ' #/components/schemas/RUMAggregationBucketsResponse'
4628
+ links :
4629
+ $ref : ' #/components/schemas/RUMResponseLinks'
4630
+ meta :
4631
+ $ref : ' #/components/schemas/RUMResponseMetadata'
4632
+ type : object
4633
+ RUMBucketResponse :
4634
+ description : Bucket values.
4635
+ properties :
4636
+ by :
4637
+ additionalProperties :
4638
+ description : The values for each group-by.
4639
+ type : string
4640
+ description : The key-value pairs for each group-by.
4641
+ example :
4642
+ ' @session.type ' : user
4643
+ ' @type ' : view
4644
+ type : object
4645
+ computes :
4646
+ additionalProperties :
4647
+ $ref : ' #/components/schemas/RUMAggregateBucketValue'
4648
+ description : A map of the metric name to value for regular compute, or a
4649
+ list of values for a timeseries.
4650
+ type : object
4651
+ type : object
4652
+ RUMCompute :
4653
+ description : A compute rule to compute metrics or timeseries.
4654
+ properties :
4655
+ aggregation :
4656
+ $ref : ' #/components/schemas/RUMAggregationFunction'
4657
+ interval :
4658
+ description : ' The time buckets'' size (only used for type=timeseries)
4659
+
4660
+ Defaults to a resolution of 150 points.'
4661
+ example : 5m
4662
+ type : string
4663
+ metric :
4664
+ description : The metric to use.
4665
+ example : ' @duration'
4666
+ type : string
4667
+ type :
4668
+ $ref : ' #/components/schemas/RUMComputeType'
4669
+ required :
4670
+ - aggregation
4671
+ type : object
4672
+ RUMComputeType :
4673
+ default : total
4674
+ description : The type of compute.
4675
+ enum :
4676
+ - timeseries
4677
+ - total
4678
+ type : string
4679
+ x-enum-varnames :
4680
+ - TIMESERIES
4681
+ - TOTAL
4504
4682
RUMEvent :
4505
4683
description : Object description of a RUM event after being processed and stored
4506
4684
by Datadog.
@@ -4570,6 +4748,89 @@ components:
4570
4748
meta :
4571
4749
$ref : ' #/components/schemas/RUMResponseMetadata'
4572
4750
type : object
4751
+ RUMGroupBy :
4752
+ description : A group-by rule.
4753
+ properties :
4754
+ facet :
4755
+ description : The name of the facet to use (required).
4756
+ example : ' @view.time_spent'
4757
+ type : string
4758
+ histogram :
4759
+ $ref : ' #/components/schemas/RUMGroupByHistogram'
4760
+ limit :
4761
+ default : 10
4762
+ description : The maximum buckets to return for this group-by.
4763
+ format : int64
4764
+ type : integer
4765
+ missing :
4766
+ $ref : ' #/components/schemas/RUMGroupByMissing'
4767
+ sort :
4768
+ $ref : ' #/components/schemas/RUMAggregateSort'
4769
+ total :
4770
+ $ref : ' #/components/schemas/RUMGroupByTotal'
4771
+ required :
4772
+ - facet
4773
+ type : object
4774
+ RUMGroupByHistogram :
4775
+ description : ' Used to perform a histogram computation (only for measure facets).
4776
+
4777
+ Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
4778
+ properties :
4779
+ interval :
4780
+ description : The bin size of the histogram buckets.
4781
+ example : 10
4782
+ format : double
4783
+ type : number
4784
+ max :
4785
+ description : ' The maximum value for the measure used in the histogram
4786
+
4787
+ (values greater than this one are filtered out).'
4788
+ example : 100
4789
+ format : double
4790
+ type : number
4791
+ min :
4792
+ description : ' The minimum value for the measure used in the histogram
4793
+
4794
+ (values smaller than this one are filtered out).'
4795
+ example : 50
4796
+ format : double
4797
+ type : number
4798
+ required :
4799
+ - interval
4800
+ - min
4801
+ - max
4802
+ type : object
4803
+ RUMGroupByMissing :
4804
+ description : The value to use for logs that don't have the facet used to group
4805
+ by.
4806
+ oneOf :
4807
+ - $ref : ' #/components/schemas/RUMGroupByMissingString'
4808
+ - $ref : ' #/components/schemas/RUMGroupByMissingNumber'
4809
+ RUMGroupByMissingNumber :
4810
+ description : The missing value to use if there is a number valued facet.
4811
+ format : double
4812
+ type : number
4813
+ RUMGroupByMissingString :
4814
+ description : The missing value to use if there is string valued facet.
4815
+ type : string
4816
+ RUMGroupByTotal :
4817
+ default : false
4818
+ description : A resulting object to put the given computes in over all the matching
4819
+ records.
4820
+ oneOf :
4821
+ - $ref : ' #/components/schemas/RUMGroupByTotalBoolean'
4822
+ - $ref : ' #/components/schemas/RUMGroupByTotalString'
4823
+ - $ref : ' #/components/schemas/RUMGroupByTotalNumber'
4824
+ RUMGroupByTotalBoolean :
4825
+ description : If set to true, creates an additional bucket labeled "$facet_total".
4826
+ type : boolean
4827
+ RUMGroupByTotalNumber :
4828
+ description : A number to use as the key value for the total bucket.
4829
+ format : double
4830
+ type : number
4831
+ RUMGroupByTotalString :
4832
+ description : A string to use as the key value for the total bucket.
4833
+ type : string
4573
4834
RUMQueryFilter :
4574
4835
description : The search and filter query settings.
4575
4836
properties :
@@ -4700,6 +4961,16 @@ components:
4700
4961
x-enum-varnames :
4701
4962
- TIMESTAMP_ASCENDING
4702
4963
- TIMESTAMP_DESCENDING
4964
+ RUMSortOrder :
4965
+ description : The order to use, ascending or descending.
4966
+ enum :
4967
+ - asc
4968
+ - desc
4969
+ example : asc
4970
+ type : string
4971
+ x-enum-varnames :
4972
+ - ASCENDING
4973
+ - DESCENDING
4703
4974
RUMWarning :
4704
4975
description : A warning message indicating something that went wrong with the
4705
4976
query.
@@ -10043,6 +10314,41 @@ paths:
10043
10314
x-menu-order : 10
10044
10315
x-undo :
10045
10316
type : safe
10317
+ /api/v2/rum/analytics/aggregate :
10318
+ post :
10319
+ description : The API endpoint to aggregate RUM events into buckets of computed
10320
+ metrics and timeseries.
10321
+ operationId : AggregateRUMEvents
10322
+ requestBody :
10323
+ content :
10324
+ application/json :
10325
+ schema :
10326
+ $ref : ' #/components/schemas/RUMAggregateRequest'
10327
+ required : true
10328
+ responses :
10329
+ ' 200 ' :
10330
+ content :
10331
+ application/json :
10332
+ schema :
10333
+ $ref : ' #/components/schemas/RUMAnalyticsAggregateResponse'
10334
+ description : OK
10335
+ ' 400 ' :
10336
+ $ref : ' #/components/responses/BadRequestResponse'
10337
+ ' 403 ' :
10338
+ $ref : ' #/components/responses/NotAuthorizedResponse'
10339
+ ' 429 ' :
10340
+ $ref : ' #/components/responses/TooManyRequestsResponse'
10341
+ security :
10342
+ - apiKeyAuth : []
10343
+ appKeyAuth : []
10344
+ - AuthZ : []
10345
+ summary : Aggregate RUM events
10346
+ tags :
10347
+ - RUM
10348
+ x-codegen-request-body-name : body
10349
+ x-menu-order : 3
10350
+ x-undo :
10351
+ type : safe
10046
10352
/api/v2/rum/events :
10047
10353
get :
10048
10354
description : ' List endpoint returns events that match a RUM search query.
@@ -10143,7 +10449,7 @@ paths:
10143
10449
application/json :
10144
10450
schema :
10145
10451
$ref : ' #/components/schemas/RUMSearchEventsRequest'
10146
- required : false
10452
+ required : true
10147
10453
responses :
10148
10454
' 200 ' :
10149
10455
content :
@@ -12050,7 +12356,7 @@ tags:
12050
12356
name : Metrics
12051
12357
- description : The processes API allows you to query processes data for your organization.
12052
12358
name : Processes
12053
- - description : Search your RUM events over HTTP.
12359
+ - description : Search or aggregate your RUM events over HTTP.
12054
12360
name : RUM
12055
12361
- description : ' The Roles API is used to create and manage Datadog roles, what
12056
12362
0 commit comments