Contents

# Athenian::CalculatedCodeCheckMetricsItem

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_for** | [**ForSetCodeChecks**](ForSetCodeChecks.md) |  |  |
| **granularity** | **String** | How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`. | [optional] |
| **check_runs** | **Integer** | We calculated metrics for check suites with this number of runs. Not null only if the user specified `split_by_check_runs = true`. | [optional] |
| **suites_ratio** | **Float** | Number of check suites with `check_runs` number of check runs divided by the overall number of check suites. Not null only if the user specified `split_by_check_runs = true`. | [optional] |
| **values** | [**Array<CalculatedLinearMetricValues>**](CalculatedLinearMetricValues.md) | The sequence steps from `date_from` till `date_to` by `granularity`. |  |

## Example

```ruby
require 'athenian'

instance = Athenian::CalculatedCodeCheckMetricsItem.new(
  _for: null,
  granularity: 2 week,
  check_runs: null,
  suites_ratio: null,
  values: null
)
```

Version data entries

3 entries across 3 versions & 1 rubygems

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