Skip to content

api_v1

django_spire.metric.domain.statistic.api_v1

MetricKey = Annotated[str, StringConstraints(max_length=64, pattern='^[-a-zA-Z0-9_]+$')] module-attribute

router = Router() module-attribute

StatisticValueIn

Bases: BaseModel

reference = Field(..., min_length=1, max_length=255) class-attribute instance-attribute

sub_domain_key instance-attribute

value = Decimal(1) class-attribute instance-attribute

StatisticValueOut

Bases: BaseModel

statistic_key instance-attribute

reference instance-attribute

sub_domain_key instance-attribute

timestamp instance-attribute

value instance-attribute

record_value

Source code in django_spire/metric/domain/statistic/api_v1.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
@router.post('{statistic_key}/record')
def record_value(
    request: HttpRequest, statistic_key: MetricKey, payload: StatisticValueIn
) -> StatisticValueOut:
    statistic = _get_statistic(statistic_key, active_required=True)
    sub_domain = _get_sub_domain(statistic, payload.sub_domain_key, active_required=True)
    statistic_value = statistic.services.processor.add_value(
        reference=payload.reference, sub_domain=sub_domain, value=payload.value
    )
    return StatisticValueOut(
        statistic_key=statistic.key,
        reference=statistic_value.reference,
        sub_domain_key=statistic_value.sub_domain.key,
        timestamp=statistic_value.timestamp,
        value=statistic_value.value,
    )

total_for_interval

Source code in django_spire/metric/domain/statistic/api_v1.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
@router.get('{statistic_key}/total')
def total_for_interval(
    request: HttpRequest,
    statistic_key: MetricKey,
    value_date: date_type | None = None,
    sub_domain_key: MetricKey | None = None,
) -> dict:
    statistic = _get_statistic(statistic_key)
    sub_domain = _get_sub_domain(statistic, sub_domain_key)
    start_date, end_date = statistic.services.transformation.interval_bounds(value_date)
    total = statistic.services.transformation.total_for_interval(value_date, sub_domain=sub_domain)
    return {
        'date': value_date.isoformat() if value_date else None,
        'start_date': start_date.isoformat(),
        'end_date': end_date.isoformat(),
        'total': str(total),
    }

interval_summary

Source code in django_spire/metric/domain/statistic/api_v1.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@router.get('{statistic_key}/summary')
def interval_summary(
    request: HttpRequest,
    statistic_key: MetricKey,
    start_date: date_type,
    end_date: date_type,
    sub_domain_key: MetricKey | None = None,
) -> dict:
    statistic = _get_statistic(statistic_key)
    sub_domain = _get_sub_domain(statistic, sub_domain_key)
    summary = statistic.services.transformation.interval_summary(
        start_date, end_date, sub_domain=sub_domain
    )
    return {
        'start_date': start_date.isoformat(),
        'end_date': end_date.isoformat(),
        'totals': {k.isoformat(): str(v) for k, v in summary.items()},
    }

values_for_interval

Source code in django_spire/metric/domain/statistic/api_v1.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
@router.get('{statistic_key}/values')
def values_for_interval(
    request: HttpRequest,
    statistic_key: MetricKey,
    value_date: date_type | None = None,
    sub_domain_key: MetricKey | None = None,
    limit: int = Query(1000, ge=1, le=5000),
    offset: int = Query(0, ge=0),
) -> list[StatisticValueOut]:
    statistic = _get_statistic(statistic_key)
    sub_domain = _get_sub_domain(statistic, sub_domain_key)
    values = statistic.services.transformation.values_for_interval(
        value_date, sub_domain=sub_domain
    )[offset : offset + limit]
    return [
        StatisticValueOut(
            statistic_key=statistic.key,
            reference=sv.reference,
            sub_domain_key=sv.sub_domain.key,
            timestamp=sv.timestamp,
            value=sv.value,
        )
        for sv in values
    ]