Get Notes Annual

Get monthly note publication rates.

Returns aggregated monthly counts of community notes with publication rate (ratio of published notes to total notes) for the specified date range (maximum 365 days).

Publication Rate: published_count / total_notes (0.0 if no notes)

Status Filter:

  • all: All notes regardless of status (default)
  • published: Only published notes
  • temporarilyPublished: Only temporarily published notes
  • evaluating: Only notes being evaluated
  • unpublished: Only unpublished notes

Date Range:

  • Timestamps must be in milliseconds (Unix epoch, UTC)
  • Maximum range: 365 days (approximately 12 months)
  • start_date must be <= end_date
  • Timestamps must be >= 2006-07-15 (Twitter founding) and <= current time
  • Results are automatically aggregated by month

Args: start_date: Start timestamp in milliseconds (required) end_date: End timestamp in milliseconds (required) status: Filter by specific note status or "all" (default: "all")

Returns: GraphListResponse containing: - data: List of monthly aggregated note counts with publication rates - updatedAt: Last data update timestamp (YYYY-MM-DD format)

Raises: HTTPException: 400 if validation fails, 422 if timestamp format invalid

get/api/v1/graphs/notes-annual

Request

  • Base URL: https://dev.api-birdxplorer.code4japan.org (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api-birdxplorer.code4japan.org/api/v1/graphs/notes-annual
  • Auth: none declared

Query parameters

start_dateinteger required

Start timestamp in milliseconds (Unix epoch, UTC)

end_dateinteger required

End timestamp in milliseconds (Unix epoch, UTC)

status'all' | 'published' | 'evaluating' | 'unpublished' | 'temporarilyPublished'

Filter by note publication status

languagestring nullable

Comma-separated language codes to filter by (e.g., ja,en)

keywordsstring nullable

Comma-separated keywords for AND search in note summaries

Response

Successful Response

updatedAtstring required

Last update timestamp in YYYY-MM-DD format (UTC). Derived from MAX(created_at) of source table.

Example response

{
  "data": [
    {
      "month": "2025-01"
    }
  ],
  "updatedAt": "2025-01-15"
}

Changes

No recorded changes to this operation across all 1 revision of this API.