Sha256: f530039e9b3c588d6418bcb21b40995b120f4f041f899616d70f15a2dfc5de02

Contents?: true

Size: 1.62 KB

Versions: 3

Compression:

Stored size: 1.62 KB

Contents

# Athenian::PullRequestMetricsRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_for** | [**Array<ForSetPullRequests>**](ForSetPullRequests.md) | Sets of developers and repositories for which to calculate the metrics. The aggregation is `AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers. |  |
| **metrics** | [**Array<PullRequestMetricID>**](PullRequestMetricID.md) | Requested metric identifiers. |  |
| **date_from** | **Date** | Date from when to start measuring the metrics. |  |
| **date_to** | **Date** | Date until which to measure the metrics. |  |
| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
| **granularities** | **Array<String>** | The splits of the specified time range. |  |
| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
| **exclude_inactive** | **Boolean** | Value indicating whether PRs without events in the given time frame shall be ignored. |  |
| **account** | **Integer** | Session account ID. |  |
| **fresh** | **Boolean** | Force metrics calculation on the most up to date data. | [optional] |

## Example

```ruby
require 'athenian'

instance = Athenian::PullRequestMetricsRequest.new(
  _for: null,
  metrics: null,
  date_from: null,
  date_to: null,
  timezone: null,
  granularities: null,
  quantiles: [0,0.95],
  exclude_inactive: null,
  account: null,
  fresh: null
)
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
athenian-2.1.86 docs/PullRequestMetricsRequest.md
athenian-2.1.85 docs/PullRequestMetricsRequest.md
athenian-2.1.81 docs/PullRequestMetricsRequest.md