Insight Channels

Create an insight channel for a collection

Create an insight channel fed by this collection on a schedule. The default is daily at 06:00 in the user's time zone (the one given, else their daily brief's, else America/New_York). format_id comes from GET /insight-channels/formats; omit it for a briefing tailored to the collection type. Runs once immediately unless run_now is false. Each run spends credits. Requires the write scope.

post/collections/{id}/insight-channel

Request

  • Base URL: https://studio.fintechstudios.com/api/v1
  • URL: https://studio.fintechstudios.com/api/v1/collections/{id}/insight-channel
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Request body

namestring
format_idstring
frequency'daily' | 'weekdays' | 'weekly' | 'twice_daily'
timestring

Local time, HH:MM 24-hour.

day_of_week'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'

For weekly; defaults to monday.

timezonestring

IANA time zone.

run_nowboolean

Example request

{
  "timezone": "America/New_York"
}

Response

{ insight_channel, collection_id, format_id, schedule, first_run }

Changes

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