Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions docs/commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Complete generated reference for AskNews CLI commands

# CLI command reference

Generated from AskNews CLI 0.2.3 and AskNews API 0.31.1.
Generated from AskNews CLI 0.2.5 and AskNews API 0.32.1.

The installed CLI is authoritative. Run `asknews <command> --help` for the exact options in
your version. Regenerate these pages with `pnpm sync:openapi`.
Expand All @@ -28,17 +28,14 @@ your version. Regenerate these pages with `pnpm sync:openapi`.
## Generated API groups

- [`alerts`](commands/api-alerts) — Generated alerts API operations
- [`analytics`](commands/api-analytics) — Generated analytics API operations
- [`autofilter`](commands/api-autofilter) — Generated autofilter API operations
- [`byok`](commands/api-byok) — Generated byok API operations
- [`charts`](commands/api-charts) — Generated charts API operations
- [`chat`](commands/api-chat) — Generated chat API operations
- [`distribution`](commands/api-distribution) — Generated distribution API operations
- [`forecast`](commands/api-forecast) — Generated forecast API operations
- [`graph`](commands/api-graph) — Generated graph API operations
- [`index-urls`](commands/api-index-urls) — Generated index-urls API operations
- [`news`](commands/api-news) — Generated news API operations
- [`newsletters`](commands/api-newsletters) — Generated newsletters API operations
- [`ping`](commands/api-ping) — Generated ping API operations
- [`profile`](commands/api-profile) — Generated profile API operations
- [`reddit`](commands/api-reddit) — Generated reddit API operations
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/routes/api-alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated alerts API operations

# api alerts

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
36 changes: 0 additions & 36 deletions docs/commands/routes/api-analytics.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/commands/routes/api-autofilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated autofilter API operations

# api autofilter

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/routes/api-byok.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated byok API operations

# api byok

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
33 changes: 0 additions & 33 deletions docs/commands/routes/api-charts.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/commands/routes/api-chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated chat API operations

# api chat

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
5 changes: 3 additions & 2 deletions docs/commands/routes/api-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated distribution API operations

# api distribution

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand All @@ -28,7 +28,7 @@ Get the hit share for a list of domains in a time period.

### `asknews api distribution top-n-articles-for-domains`

Get the top N domain articles by hits.
Get the top N domain articles ranked by the selected metric.

- Request: `GET /v1/distribution/articles/top_n_for_domains`
- Operation ID: `top_n_articles_for_domains`
Expand All @@ -43,6 +43,7 @@ Get the top N domain articles by hits.
| `--page` | Page number (1-based; page size = limit) Location: query. Type: integer. Optional. Default: `1`. Minimum: 1. |
| `--start-date` | Start date to filter by (timestamp in seconds since epoch) Location: query. Type: string. Optional. |
| `--end-date` | End date to filter by (timestamp in seconds since epoch) Location: query. Type: string. Optional. |
| `--metric` | Metric used to rank and count the returned articles Location: query. Type: string. Optional. Choices: surface, citation, grounded. Default: `"surface"`. |

## Global options

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/routes/api-forecast.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated forecast API operations

# api forecast

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/routes/api-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated graph API operations

# api graph

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/routes/api-index-urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated index-urls API operations

# api index-urls

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down
25 changes: 1 addition & 24 deletions docs/commands/routes/api-news.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Generated news API operations

# api news

Generated from AskNews API 0.31.1.
Generated from AskNews API 0.32.1.

## Operations

Expand Down Expand Up @@ -72,29 +72,6 @@ show the number of articles indexed per source.
| `--continents` | Continents to filter by Location: query. Type: string. Optional. |
| `--sentiment` | Sentiment to filter news articles by. Location: query. Type: string. Optional. |

### `asknews api news get-sources-report`

This endpoint is primarly used for transparency and monitoring the
diversity of the data.

Visualized at `https://asknews.app/transparency`.

Get the distribution of sources/languages/countries underlying AskNews content.

- Request: `GET /v1/sources`
- Operation ID: `get_sources_report`
- Safety: `read-only`

**Options:**

| Option | Description |
| --- | --- |
| `--n-points` | Number of points to return Location: query. Type: integer. Optional. Default: `100`. |
| `--start-timestamp` | Start timestamp to filter by Location: query. Type: string. Optional. |
| `--end-timestamp` | End timestamp to filter by Location: query. Type: string. Optional. |
| `--metric` | Metric to filter by Location: query. Type: string. Optional. Choices: duplication, countries_diversity, languages_diversity, sources_diversity, bucket_loss. Default: `"countries_diversity"`. |
| `--sampling` | Sampling to use Location: query. Type: string. Optional. Choices: 5m, 1h, 4h, 1d. Default: `"1h"`. |

### `asknews api news search-news`

Search for any news, up to the last 5 minutes or in our extensive historical archive
Expand Down
Loading
Loading