Agendas

Get an agenda's activity overview

Changed on Sep 23, 2026

Returns a live activity overview of the agenda: event volume, distributions (by language, source, end-day…), spatial viewport and thematic keywords.

Two visibility scopes. events.published (publicly visible events) is returned to every caller. events.all (events of any moderation state, moderation/refused included) is returned ONLY to administrator|moderator|internal callers and is absent otherwise. Computed on each request.

get/agendas/{agendaUid}/overview

Request

Base URL: https://api.openagenda.com/v3
URL: https://api.openagenda.com/v3/agendas/{agendaUid}/overview
Auth: one of:
- HTTP bearer
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://openagenda.com/api/auth/oauth2/authorize, token URL https://openagenda.com/api/auth/oauth2/token, scopes: events:read)

Path parameters

agendaUidinteger required

Numeric uid of the agenda.

Response

The agenda overview.

Example response

{
  "events": {
    "published": {
      "total": 28727,
      "locations": 456,
      "creators": 79,
      "timeline": {
        "current": 27,
        "passed": 7,
        "upcoming": 28693
      },
      "byLanguage": {
        "fr": 28100,
        "en": 627
      },
      "bySource": {
        "contribution": 879,
        "shared": 0,
        "aggregation": 27848
      },
      "byEndDay": {
        "2026-06-17": 12,
        "2026-06-18": 30
      },
      "laterDays": 28685,
      "viewport": {
        "topLeft": {
          "latitude": 51.09,
          "longitude": -5.14
        },
        "bottomRight": {
          "latitude": 41.33,
          "longitude": 9.56
        }
      },
      "keywords": [
        "Paris",
        "Théâtre",
        "Culture"
      ]
    },
    "all": {
      "total": 1248000,
      "byState": {
        "1": 200000,
        "2": 1043000,
        "-1": 5000
      },
      "timeline": {
        "current": 30,
        "passed": 900000,
        "upcoming": 348000
      },
      "byLanguage": {
        "fr": 1200000,
        "en": 48000
      },
      "bySource": {
        "contribution": 50000,
        "shared": 12,
        "aggregation": 1198000
      },
      "byEndDay": {
        "2026-06-17": 40
      },
      "laterDays": 347900,
      "viewport": null,
      "keywords": [
        "Lyon",
        "Concert"
      ]
    }
  },
  "recentlyAdded": {
    "window": 14,
    "bySource": {
      "contribution": 12,
      "shared": 0,
      "aggregation": 3
    }
  }
}

Changes

Sep 23, 2026504611f6f282 Revision changes
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status
Sep 22, 2026550dac9bcc88 Revision changes
- info
  the security scope agendas:read was added to the endpoint's security scheme oauth2
- info
  the security scope events:read was removed from the endpoint's security scheme oauth2
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the bad_request enum value from the / response property for the response status
- info
  removed the bad_request enum value from the / response property for the response status
- info
  removed the bad_request enum value from the / response property for the response status
- info
  removed the forbidden enum value from the / response property for the response status
- info
  removed the forbidden enum value from the / response property for the response status
- info
  removed the forbidden enum value from the / response property for the response status
- info
  removed the insufficient_scope enum value from the / response property for the response status
- info
  removed the insufficient_scope enum value from the / response property for the response status
- info
  removed the insufficient_scope enum value from the / response property for the response status
- info
  removed the not_found enum value from the / response property for the response status
- info
  removed the not_found enum value from the / response property for the response status
- info
  removed the not_found enum value from the / response property for the response status
- info
  removed the read_only_credential enum value from the / response property for the response status
- info
  removed the read_only_credential enum value from the / response property for the response status
- info
  removed the read_only_credential enum value from the / response property for the response status
- info
  removed the service_unavailable enum value from the / response property for the response status
- info
  removed the service_unavailable enum value from the / response property for the response status
- info
  removed the service_unavailable enum value from the / response property for the response status
- info
  removed the unauthorized enum value from the / response property for the response status
- info
  removed the unauthorized enum value from the / response property for the response status
- info
  removed the unauthorized enum value from the / response property for the response status

Operation history (3 revisions)