Skip to content

Commit

Permalink
use /v2/datasets/{datasetId}/statistics approach
Browse files Browse the repository at this point in the history
  • Loading branch information
MFori committed Dec 20, 2024
1 parent 425bbbc commit 4cc52db
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 65 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
title: GetDatasetStatisticsResponse
required:
- data
type: object
properties:
data:
type: object
properties:
fieldStatistics:
type: object
additionalProperties:
$ref: ./DatasetFieldStatistics.yaml
description: 'When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field.
This property provides statistics for each field from dataset fields schema.
<br/></br>See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information.'
4 changes: 2 additions & 2 deletions apify-api/openapi/components/tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -758,8 +758,8 @@
x-legacy-doc-urls:
- '#/reference/datasets/item-collection'
x-trait: 'true'
- name: Datasets/Field statistics
x-displayName: Field statistics
- name: Datasets/Statistics
x-displayName: Statistics
x-parent-tag-name: Datasets
x-trait: 'true'
- name: Request queues
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/x-tag-groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
- Datasets/Dataset collection
- Datasets/Dataset
- Datasets/Item collection
- Datasets/Field statistics
- Datasets/Statistics
- name: Request queues
tags:
- Request queues
Expand Down
4 changes: 2 additions & 2 deletions apify-api/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -566,8 +566,8 @@ paths:
$ref: 'paths/datasets/datasets@{datasetId}.yaml'
'/v2/datasets/{datasetId}/items':
$ref: 'paths/datasets/datasets@{datasetId}@items.yaml'
'/v2/datasets/{datasetId}/field-statistics':
$ref: 'paths/datasets/datasets@{datasetId}@field-statistics.yaml'
'/v2/datasets/{datasetId}/statistics':
$ref: 'paths/datasets/datasets@{datasetId}@statistics.yaml'
/v2/request-queues:
$ref: paths/request-queues/request-queues.yaml
'/v2/request-queues/{queueId}':
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
get:
tags:
- Datasets/Statistics
summary: Get dataset statistics
description: |
Returns statistics for given dataset.
Currently provides only [field statistics](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics).
operationId: dataset_statistics_get
parameters:
- name: datasetId
in: path
description: Dataset ID or `username~dataset-name`.
required: true
style: simple
schema:
type: string
example: WkzbQMuFYuamGv3YF
- name: token
in: query
description: |
API authentication token. It is required only when using the `username~dataset-name` format for `datasetId`.
style: form
explode: true
schema:
type: string
example: soSkq9ekdmfOslopH
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: "../../components/schemas/datasets/GetDatasetStatisticsResponse.yaml"
example:
data:
fieldStatistics:
name:
nullCount: 122
price:
min: 59
max: 89
# TODO: add clients methods
# x-js-parent: DatasetClient
# x-js-name: statistics
# x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#statistics
# x-py-parent: DatasetClientAsync
# x-py-name: statistics
# x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#statistics

0 comments on commit 4cc52db

Please sign in to comment.