facebook

Events

Returns the events listed on a Facebook city or region events page, each with a title, link, cover image, the start time, the venue, and the going and interested counts.

Use it to see what is on in a place, optionally narrowed by a time filter; use profile/events for one page's own events. The optional include=details adds the description, address and hosts.

Metered: 10–130 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.

Paginates by cursor: see Pagination.

get/v1/facebook/events

Request

  • Base URL: https://api.insightsocial.app
  • URL: https://api.insightsocial.app/v1/facebook/events
  • Auth: API key in header x-api-key

Query parameters

urlstring required
Example:https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547

Full URL of the city's Facebook Events page.

time'today' | 'this_week' | 'next_week'

Relative time window. Defaults to all time when omitted.

cursorstring

Cursor returned by the previous response for pagination.

include'details'

Set to details (one token only) to fill, on every event in this one call, post.ext.event.description, address, city, latitude, longitude, hosts, host_context_text, category, privacy, is_canceled and attendance_count, and the host credit on post.author.display_name. Without it the call is unchanged.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required
platformstring required
endpointstring required
schema_version'2' required
unavailablestring[] required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required
idempotent_replayboolean required
charge_reasonstring required
free_callboolean required

Changes

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