Gateway Published Content Sample
", "campaigncode" : "CMP_CD_01", "categories" : [ { "name" : "All Webinars" }, { "name" : "Encompass" }, { "name" : "Utilization" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ], "filtergroups" : [ { "name" : "Filter Group 1", "filters" : [ { "name" : "Filter 1" }, { "name" : "Filter 2" }, { "name" : "Filter 3" } ] }, { "name" : "Filter Group 2", "filters" : [ { "name" : "Filter A" }, { "name" : "Filter B" }, { "name" : "Filter C" } ] } ], "thumbnail" : "http://gateway.on24.com/event/14/30/43/9/rt/1/images/thumbnail/sample.png", "contenttype" : "webcast", "url" : "https://gateway.on24.com/wcc/gateway/integrationdevs/5001240", "livestart" : "2016-09-09T10:00:23-07:00", "liveend" : "2016-09-09T10:00:23-07:00", "archivestart" : "2016-09-09T10:00:23-07:00", "archiveend" : "2016-09-09T10:00:23-07:00" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "The client id {clientId} is inactive. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The Engagement Hub {gatewayId} doesn't exist." } } } }, "/client/{clientId}/engagedaccount" : { "get" : { "tags" : [ "Client Level Analytics" ], "summary" : "Engaged Accounts", "description" : "Returns a list of the top engaged accounts as displayed in the Account Engagement Cloud with a link to their Account Engagement Profile. Up to 100 accounts will be listed.\n\n- If there are no engaged accounts, an empty list will be returned.\n- Only the last 90 days of data is used to generate the list.", "operationId" : "AnalyticsClientLevel.EngagedAccounts", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" } ], "responses" : { "200" : { "description" : "Return list of engaged accounts", "content" : { "application/json" : { "example" : { "accounts" : [ { "name" : "Microsoft", "domains" : [ "microsoft.com" ], "profileurl" : "URL_TO_MICROSOFT_ACCOUNT" }, { "name" : "Ibm", "domains" : [ "ibm.com" ], "profileurl" : "URL_TO_IBM_ACCOUNT" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist." } } } }, "/client/{clientId}/event" : { "get" : { "tags" : [ "Client Level Analytics" ], "summary" : "Events", "description" : "Returns a listing of events for a particular client. Events belonging to sub-client accounts are not included in the response.\n\n- If **startDate** and **endDate** are not sent, the response will return all events from the past 3 months.\n- The **startDate** and **endDate** will filter the list of events based on **dateFilterMode** parameter value.\n- If **includesubaccounts** is \"Y\", pagination will be required. Both **pageOffset** and **itemsPerPage** parameters will be available. Response schema differs.\n- **subaccounts** parameter conditions:\n - Value can be 1 or more child client IDs (multiple values will need to be delimited by a comma).\n - Child client IDs must be under the {clientId} of the request.\n - If **subaccounts** is provided and **includeSubaccounts=N** (either explicitly or by default), the following error message is returned: *\"You have to set includesubaccounts='Y' in order to filter by subaccounts.\".*\n - If **subaccounts** includes multiple values and at least one value is not valid, an error message is returned.\n - When **subaccounts** is provided, the response will only return data for the child client IDs included in the parameter.\n- **dateFilterMode** accepted values (not case-sensitive):\n - \"goodafter\" (default): date and time an event is first available for the audience.\n - \"updated\": filters based on \"lastupdated\" attribute in the response. It may be between 2 and 12 hours to see changes on \"lastupdated\". The \"lastupdated\" is the last time an event had audience activity as:\n - Event is created\n - New Registrant\n - New Attendee\n - Poll is answered\n - Survey is answered\n - \"modified\": filters based on \"lastmodified\" attribute in the response. \"lastmodified\" is the last time the event's information was modified.\n - \"creation\": date and time an event was created.\n - \"livestart\": date and time an event starts the live broadcasting.\n - \"liveend\": date and time an event ends the live broadcasting.\n - \"archivestart\": date and time an event will be available on-demand for the audience.\n - \"archiveend\": date and time an event won't be available anymore for the audience.\n- **filterOrder** accepted values (not case-sensitive):\n - \"asc\" (default): ascending\n - \"desc\": descending\n- **contentType** accepted values (not case-sensitive):\n - \"all\" (default)\n - \"experience\": Experience Hub contents\n - \"gateway\": Engagement Hub contents\n - \"golive\": Go Live events\n - \"pdf\": Documents from Media Manager library\n - \"video\": Videos from Media Manager library\n - \"webcast\": Elite webinars\n - \"webpage\": Links from Media Library\n - \"forum\": Forum events\n- In the Client Level Events response, \"eventlocation\" is the same as the \"campaigncode\" (Campaign Code).", "operationId" : "AnalyticsClientLevel.Events", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "dateInterval", "in" : "query", "description" : "Number of days returned in a response. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64" }, "example" : 30 }, { "name" : "dateIntervalOffset", "in" : "query", "description" : "Number of days from which the interval should encompass. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 4 }, { "name" : "dateIntervalTimezone", "in" : "query", "description" : "Timezone to be used for determining the 24 hour period that constitutes a day. See Rolling Interval.", "schema" : { "type" : "string", "default" : "America/Los_Angeles" }, "example" : "America/Los_Angeles" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "pageoffset", "in" : "query", "description" : "Number of page to retrieve", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 1 }, { "name" : "startdate", "in" : "query", "description" : "startDate's max range between start and end dates can be up to 6 months", "schema" : { "type" : "string", "default" : "90 days before current date" }, "example" : "2007-12-03" }, { "name" : "enddate", "in" : "query", "description" : "endDate's max range between start and end dates can be up to 6 months", "schema" : { "type" : "string", "default" : "current date" }, "example" : "2007-12-05" }, { "name" : "includesubaccounts", "in" : "query", "description" : "If 'Y' then sub-accounts will be included in the response", "schema" : { "type" : "string", "default" : "N" }, "example" : "Y" }, { "name" : "datefiltermode", "in" : "query", "description" : "Type of date to be used with the startDate and endDate parameters.", "schema" : { "type" : "string", "default" : "goodafter" }, "example" : "creation" }, { "name" : "filterorder", "in" : "query", "description" : "The filter order", "schema" : { "type" : "string", "default" : "asc" }, "example" : "desc" }, { "name" : "includeinactive", "in" : "query", "description" : "If 'Y' then inactive events will be included in the response", "schema" : { "type" : "string", "default" : "N" }, "example" : "Y" }, { "name" : "contenttype", "in" : "query", "description" : "Filter events by contentType", "schema" : { "type" : "string", "default" : "all" }, "example" : "webcast" }, { "name" : "itemsperpage", "in" : "query", "description" : "Number of items to be retrieved per page", "schema" : { "type" : "integer", "format" : "int64", "default" : 100 }, "example" : 25 }, { "name" : "subaccounts", "in" : "query", "description" : "Comma separated list of child client ids", "schema" : { "type" : "string" }, "example" : "22921, 32295" } ], "responses" : { "200" : { "description" : "Return list of events.", "content" : { "application/json" : { "examples" : { "includesubaccounts is not passed or if includesubaccounts = N" : { "description" : "includesubaccounts is not passed or if includesubaccounts = N", "value" : { "totalevents" : 9, "events" : [ { "eventanalytics" : { "totalregistrants" : 1, "totalattendees" : 1, "liveattendees" : 1, "ondemandattendees" : 1, "averageliveminutes" : 1, "averagecumulativeliveminutes" : 1, "averagearchiveminutes" : 1, "averagecumulativearchiveminutes" : 1, "totalcumulativeliveminutes" : 36, "totalcumulativearchiveminutes" : 0, "totalcumulativeminutes" : 36, "totalmediaplayerminutes" : 36, "totallivemediaplayerminutes" : 36, "totalarchivemediaplayerminutes" : 0 }, "eventid" : 9922511, "clientid" : 22950, "goodafter" : "2017-02-02T03:35:00-08:00", "isactive" : true, "regrequired" : true, "description" : "New Live event on 2 FEB 2017", "promotionalsummary" : "Promotional Summary Sample", "regnotificationrequired" : true, "displaytimezonecd" : "America/Los_Angeles", "eventtype" : "Live PC Mic", "category" : "Marketing", "createtimestamp" : "2017-02-02T03:27:47-08:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2017-02-02T03:27:47-08:00", "lastupdated" : "2017-02-02T03:29:00-08:00", "iseliteexpired" : "N", "application" : "Investor Relations", "livestart" : "2017-02-02T03:20:00-08:00", "liveend" : "2017-02-02T04:05:00-08:00", "archivestart" : "2017-02-02T04:35:00-08:00", "archiveend" : "2018-02-02T04:35:00-08:00", "audienceurl" : "https://eventqa.on24.com/wcc/r/9922511/130A59F68EA9F7E1E2FE9B7FBBA54A9F", "scheduledeventduration" : 60, "eventprofile" : "Stonehenge Profile (918)", "streamtype" : "whitepaper", "audiencekey" : "130A59F68EA9F7E1E2FE9B7FBBA54A9F", "extaudienceurl" : "www.google.com", "reporturl" : "https://dataqa.on24.com/webcast/report?e=9922511&k=A8EBCD7A76D8BF36D71DCFEBED688237", "uploadurl" : "https://wcc.on24.com/webcast/login", "pmurl" : "https://wcc.on24.com/webcast/present?e=9922511&k=A8EBCD7A76D8BF36D71DCFEBED688237", "previewurl" : "http://eventqa.on24.com/webcast/previewlobby?e=9922511&k=A8EBCD7A76D8BF36D71DCFEBED688237", "contenttype" : "webcast", "campaigncode" : "campaignCode31536770910802", "eventlocation" : "campaignCode31536770910802", "createdby" : "Joe Smith", "ishybridevent" : true, "partnerrefstats" : [ { "code" : "-", "count" : 2 } ], "tags" : [ "custom tag 1", "custom tag 2", "custom tag 3" ], "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "speakers" : [ { "name" : "Matthew Parfitt", "title" : "President", "company" : "Vulture US", "description" : "As President of Vuture in North America, Matt focuses on marketing communications in the legal sector which 4 years ago saw him launch Vuture in the USA. Matt is a regular speaker and active member of the LMA and has been chair the New York CRM group for the last 3 years." }, { "name" : "Samantha McKenna", "title" : "Director of Sales", "company" : "ON24 Inc.", "description" : "As Director of Sales, Samantha McKenna heads up the strategy behind ON24's legal presence. A thought leader in the legal industry, Sam works directly with ON24's legal clients on their go-to-market strategy for webinars, thought leadership events, virtual learning environments and virtual communications for alumni relations. She has served the legal community by attending the last seven Legal Marketing Association annual conferences, supporting several LMA chapters with sponsorships and by working directly with LMA on their national webinars as of 2015." } ], "eventstd1" : "EF1", "eventstd2" : "EF2", "eventstd3" : "EF3", "eventstd4" : "EF4", "eventstd5" : "EF5", "istestevent" : true, "surveyurls" : [ "https://eventqa.on24.com/eventManager/presentation/survey.jsp?eventId=9922511&sessionid=1&key=C9E1154B35A0AE0F3AF2858E25EA5509&survey=survey1" ], "customaccounttags" : [ { "groupid" : 103, "groupname" : "Group 3", "tagid" : 747, "tagname" : "Option 3-A" } ], "customeventfields" : [ { "name" : "custom1", "label" : "Region", "value" : "North America" }, { "name" : "custom2", "label" : "Org", "value" : "Research" }, { "name" : "custom3", "label" : "CRM Campaign Code", "value" : "111" }, { "name" : "custom4", "label" : "MAP Campaign Code", "value" : "222" }, { "name" : "custom5", "label" : "Product", "value" : "Computer" } ], "media" : { "audios" : [ "http://eventqa.on24.com/media_qa/news/corporatevideo/events/58/81/61/9/rt/demo_audio.wav" ], "videos" : [ "http://pmqa.on24.com/media_qa/cv/events/58/81/61/9/rt/1_fhvideo1_demo_video.mp4" ], "slides" : [ "http://eventqa.on24.com/event/58/72/14/5/rt/1/slide/slide/demo_slide.jpg" ], "videoclips" : [ "http://eventqa.on24.com/media_qa/news/corporatevideo/events/58/72/14/5/rt/1/flashdemo/flashdemo/demo_clip.mp4" ], "urls" : [ "http://www.hotmail.com", "http://www.on24.com" ], "polls" : [ "http://eventqa.on24.com/eventManager/EventQuestionServlet?mode=get&eventid=9922511&mediaurlid=91997329", "http://eventqa.on24.com/eventManager/EventQuestionServlet?mode=get&eventid=9922511&mediaurlid=92221593" ] } } ] } }, "includesubaccounts = Y" : { "description" : "includesubaccounts = Y", "value" : { "pagecount" : 2, "totalevents" : 105, "currentpage" : 1, "events" : [ { "eventanalytics" : { "totalregistrants" : 1, "totalattendees" : 1, "liveattendees" : 1, "ondemandattendees" : 1, "averageliveminutes" : 1, "averagecumulativeliveminutes" : 1, "averagearchiveminutes" : 1, "averagecumulativearchiveminutes" : 1, "totalcumulativeliveminutes" : 36, "totalcumulativearchiveminutes" : 0, "totalcumulativeminutes" : 36, "totalmediaplayerminutes" : 36, "totallivemediaplayerminutes" : 36, "totalarchivemediaplayerminutes" : 0 }, "eventid" : 9922511, "clientid" : 22950, "goodafter" : "2017-02-02T03:35:00-08:00", "isactive" : true, "regrequired" : true, "description" : "New Live event on 2 FEB 2017", "promotionalsummary" : "Promotional Summary Sample", "regnotificationrequired" : true, "displaytimezonecd" : "Asia/Kolkata", "eventtype" : "Live PC Mic", "category" : "Marketing", "createtimestamp" : "2017-02-02T03:27:47-08:00", "localelanguagecd" : "fr", "lastmodified" : "2017-02-02T03:27:47-08:00", "lastupdated" : "2017-02-02T03:29:00-08:00", "iseliteexpired" : "N", "application" : "Investor Relations", "livestart" : "2017-02-02T03:20:00-08:00", "liveend" : "2017-02-02T04:05:00-08:00", "archivestart" : "2017-02-02T04:35:00-08:00", "archiveend" : "2018-02-02T04:35:00-08:00", "audienceurl" : "https://eventqa.on24.com/wcc/r/9922511/130A59F68EA9F7E1E2FE9B7FBBA54A9F", "eventprofile" : "Stonehenge Profile (918)", "streamtype" : "whitepaper", "audiencekey" : "130A59F68EA9F7E1E2FE9B7FBBA54A9F", "extaudienceurl" : "www.google.com", "reporturl" : "https://dataqa.on24.com/webcast/report?e=9922511&k=A8EBCD7A76D8BF36D71DCFEBED688237", "uploadurl" : "https://wcc.on24.com/webcast/login", "pmurl" : "https://pmqa.on24.com/presentationManager/login.jsp?eventid=9922511&sessionid=1&key=A8EBCD7A76D8BF36D71DCFEBED688237", "previewurl" : "http://eventqa.on24.com/webcast/previewlobby?e=9922511&k=A8EBCD7A76D8BF36D71DCFEBED688237", "contenttype" : "webcast", "campaigncode" : "campaignCode31536770910802", "eventlocation" : "campaignCode31536770910802", "ishybridevent" : true, "istestevent" : true, "partnerrefstats" : [ { "code" : "-", "count" : 2 } ], "tags" : [ "custom tag 1", "custom tag 2", "custom tag 3" ], "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "speakers" : [ { "name" : "Matthew Parfitt", "title" : "President", "company" : "Vulture US", "description" : "As President of Vuture in North America, Matt focuses on marketing communications in the legal sector which 4 years ago saw him launch Vuture in the USA. Matt is a regular speaker and active member of the LMA and has been chair the New York CRM group for the last 3 years." }, { "name" : "Samantha McKenna", "title" : "Director of Sales", "company" : "ON24 Inc.", "description" : "As Director of Sales, Samantha McKenna heads up the strategy behind ON24's legal presence. A thought leader in the legal industry, Sam works directly with ON24's legal clients on their go-to-market strategy for webinars, thought leadership events, virtual learning environments and virtual communications for alumni relations. She has served the legal community by attending the last seven Legal Marketing Association annual conferences, supporting several LMA chapters with sponsorships and by working directly with LMA on their national webinars as of 2015." } ], "eventstd1" : "EF1", "eventstd2" : "EF2", "eventstd3" : "EF3", "eventstd4" : "EF4", "eventstd5" : "EF5", "surveyurls" : [ "https://eventqa.on24.com/eventManager/presentation/survey.jsp?eventId=9922511&sessionid=1&key=C9E1154B35A0AE0F3AF2858E25EA5509&survey=survey1" ], "customaccounttags" : [ { "groupid" : 103, "groupname" : "Group 3", "tagid" : 747, "tagname" : "Option 3-A" } ], "media" : { "audios" : [ "http://eventqa.on24.com/media_qa/news/corporatevideo/events/58/81/61/9/rt/demo_audio.wav" ], "videos" : [ "http://pmqa.on24.com/media_qa/cv/events/58/81/61/9/rt/1_fhvideo1_demo_video.mp4" ], "slides" : [ "http://eventqa.on24.com/event/58/72/14/5/rt/1/slide/slide/demo_slide.jpg" ], "videoclips" : [ "http://eventqa.on24.com/media_qa/news/corporatevideo/events/58/72/14/5/rt/1/flashdemo/flashdemo/demo_clip.mp4" ], "urls" : [ "http://www.hotmail.com", "http://www.on24.com" ], "polls" : [ "http://eventqa.on24.com/eventManager/EventQuestionServlet?mode=get&eventid=9922511&mediaurlid=91997329", "http://eventqa.on24.com/eventManager/EventQuestionServlet?mode=get&eventid=9922511&mediaurlid=92221593" ] } } ] } }, "VE Account" : { "description" : "VE Account", "value" : { "totalevents" : 5, "events" : [ { "eventid" : 14031264, "clientid" : 22957, "goodafter" : "2016-10-18T04:35:00-07:00", "isactive" : true, "regrequired" : true, "description" : "Test VE Event", "promotionalsummary" : "Promotional Summary Sample", "displaytimezonecd" : "America/Los_Angeles", "createtimestamp" : "2016-10-18T04:34:06-07:00", "lastmodified" : "2016-10-18T04:34:06-07:00", "lastupdated" : "2016-10-20T09:58:12-07:00", "livestart" : "2017-02-02T03:20:00-08:00", "liveend" : "2017-02-02T04:05:00-08:00", "archivestart" : "2017-02-02T04:35:00-08:00", "archiveend" : "2018-02-02T04:35:00-08:00", "audienceurl" : "https://event.on24.com/wcc/r/14031264/9AB4ABD834D841E9E5ED9124D266848B", "reporturl" : "https://data.on24.com/webcast/report?e=14031264&k=A8EBCD7A76D8BF36D71DCFEBED688237", "contenttype" : "virtualenvironment", "campaigncode" : "campaignCode31536770910802", "eventlocation" : "campaignCode31536770910802", "istestevent" : true, "partnerrefstats" : [ { "code" : "-", "count" : 2 } ] } ] } }, "Go Live" : { "description" : "Go Live", "value" : { "totalevents" : 1, "events" : [ { "eventid" : 6622151, "clientid" : 32120, "goodafter" : "2021-10-01T03:35:00-07:00", "isactive" : true, "regrequired" : false, "description" : "aosorio_golive_test", "promotionalsummary" : "aosorio_golive_test", "regnotificationrequired" : true, "displaytimezonecd" : "America/Los_Angeles", "eventtype" : "Go Live", "createtimestamp" : "2021-09-01T03:27:47-08:00", "localelanguagecd" : "en", "lastupdated" : "2021-09-01T03:27:47-08:00", "livestart" : "2021-10-01T03:35:00-07:00", "liveend" : "2021-10-01T03:35:00-07:00", "archivestart" : "2021-10-01T03:35:00-07:00", "archiveend" : "2021-10-01T03:35:00-07:00", "audienceurl" : "https://goliveqa.on24.com/event/6622151", "previewurl" : "https://goliveqa.on24.com/event/6622151?previewmode=true", "contenttype" : "golive", "campaigncode" : "campaignCode315", "eventlocation" : "campaignCode315", "istestevent" : true, "partnerrefstats" : [ { "code" : "-", "count" : 28 } ], "categories" : [ "category 1", "category 2", "category 3" ], "tracks" : [ "track 1", "track 2", "track 3" ], "categoriesdata" : [ { "id" : 21, "name" : "category 1" }, { "id" : 22, "name" : "category 2" }, { "id" : 23, "name" : "category 3" } ], "trackdata" : [ { "id" : 11, "name" : "track 1" }, { "id" : 12, "name" : "track 2" }, { "id" : 13, "name" : "track 3" } ], "livedays" : [ { "id" : 66, "title" : "LIVE DAY 1", "livestarttime" : "2021-10-01T03:35:00-07:00", "liveendtime" : "2021-10-01T03:40:00-07:00" } ], "contents" : [ { "title" : "content name", "type" : "Keynote", "status" : "published", "resourceid" : 6793591, "externalurl" : "http://www.on24.com" }, { "title" : "Opening Keynote", "type" : "webcast", "status" : "Published", "resourceid" : 1234567, "sessionstarttime" : "2026-04-02T08:15:00-07:00", "eventid" : 4567890, "livedayid" : 1001, "tracks" : [ { "id" : 11, "name" : "track 1" }, { "id" : 12, "name" : "track 2" } ], "categories" : [ { "id" : 21, "name" : "category 1" }, { "id" : 22, "name" : "category 2" } ] } ], "speakers" : [ { "name" : "Speaker Sample", "title" : "Mr.", "company" : "CO", "description" : "Description sample." } ], "sponsors" : [ { "id" : 135125, "name" : "Sponsor A", "staff" : [ { "firstname" : "Jim", "lastname" : "Darnald", "company" : "Company Name", "title" : "Sr. Manager", "email" : "jim.darnald@test.com", "roles" : [ "Admin", "Rep" ] } ] } ] } ] } }, "Broadcast Video (encoder fragment)" : { "description" : "If the event is configured as Broadcast Video type, the response will include encoder information similar as following sample fragment:", "value" : { "encoders" : [ { "encoder" : "Encoder A", "url" : "rtmp://fmseosa.on24.com/liveeosa", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_A" }, { "encoder" : "Encoder B", "url" : "rtmp://fmseosb.on24.com/liveeosb", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_B" } ] } } } } } }, "400" : { "description" : "Error, incorrect date formats." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The client {clientId} doesn't exist." } } }, "post" : { "tags" : [ "Event Management" ], "summary" : "Create/Copy a Webinar", "description" : "Creates a new Webinar or Forum. When an existing event id is provided in query parameter **eventsource**, a copy of that event is created instead.\n\n- When an existing event id is provided in query parameter **eventsource**, the new event created by this Endpoint will copy all the other fields from this existing event except the **liveStart** and **liveDuration**.\n- Any of the parameters can be overridden, all parameters in the Event Creation are accepted.\n- Required form parameters: **liveDuration** and **liveStart.**\n- The copy process will copy the event source's tags (funnel, campaign, sales) and resources uploaded to it (PDF,mp4, etc)\n- **liveDuration** parameter conditions:\n - When copying a webinar, users are able to provide a liveDuration value in 15 minute increments (e.g. 15, 30, 45, 60, etc.) up to 120 minutes.\n - Above 120 minutes, increments will be 30 minutes up to 480 minutes.\n - The maximum allowed liveDuration is 480 minutes.\n- **liveStart** accepted date/time formats:\n - **MM/DD/YYYY hh:mm a** (08/26/2016 09:00 AM)\n - **YYYY-MM-DDThh:mm:ss** Default timezone will be Pacific Time. (2016-08-26T09:00:00)\n - **YYYY-MM-DDThh:mm:ss±zz:zz** where ±zz:zz is timezone's offset (2016-08-26T09:00:00-07:00)\n - JavaScript Date.toString() format is also supported (Wed Apr 04 2018 16:12:41 GMT+0200 (CEST) )\n- **tagCampaign** parameter conditions:\n - When copying a webinar users are allowed to add up to 10 custom tags via the tagCampaign parameter.\n - Every tag that is associated with the webinar should be available in the **tags** array field in the response.\n - The following characters can not be used and will result in an error: £$!%&*()}{@#~?><',\"|=_+¬\n- **customAccountTag** parameter conditions:\n - Supported only for client accounts with enabled custom account tags.\n - When copying a webinar for an account with enabled custom account tags, users are allowed to add up to 3 tag IDs\n - Provided values must match configured client account values.\n- **languageCd** / **countryCd** parameters conditions:\n - Following are allowed pairs of language/country values when copying an event:\n - Chinese (Simplified): languageCd=**\"zh\"**, countryCd=**\"CN\"**\n - Chinese (Traditional): languageCd=**\"zh\"**, countryCd=**\"TW\"**\n - English (UK): languageCd=**\"en\"**, countryCd=**\"UK\"**\n - For other languages, No countryCd is allowed.\n- When copying a webinar, the following features will be copied from the source event unless their values are overriden:\n - Title. *In the following format: 'Copy of' + [source event name]*\n - Event Type\n - Duration\n - Language\n - Funnel Tags\n - Campaign Tags\n - Custom Account Tags\n - Registration page:\n - Banner\n - Registration fields\n - Page design\n - Email notifications configuration\n - Videos and Slides\n - Console customization\n- **Elements that are not copied:**\n - Start time\n - Archive configuration\n - Security configuration\n\n## Conditions & Restrictions\nWhen creating a webinar, certain conditions must be met.\n\nWebinar Type and Account Type are the primary data our REST API uses to determine whether you can create a webinar or not.\n\nThe following list shows which Account Types can create specific webinars.\n\n**Elite Pro Accounts**\n\n| Field Name | Platform Name |\n|---|---|\n| fav | Live Video and Audio (screen share) |\n\n**Elite Accounts**\n\n| Field Name | Platform Name |\n|---|---|\n| fav | Live Video and Audio (screen share) |\n| Ondemand | On Demand Recording |\n| Simulive | Simu-live |\n| sim2live | Sim-2-live |\n| encodeonsite | Broadcast Video |\n| forum | Forum |\n\n**Kollective**\n\nFor accounts using Kollective streaming, when the **Kollective Delivery Setting** is set to **Kollective Only** or **Kollective with CDN failover**, here are the webinars that are allowed to be created:\n\n| Field Name | Platform Name |\n|---|---|\n| fav | Live Video and Audio (screen share) |\n| encodeonsite | Broadcast Video |", "operationId" : "EventManagement.CreateAWebinar", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The event will be created under this client id", "required" : true, "schema" : { "type" : "string" }, "example" : 18091 }, { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "Possible values: \"application/x-www-form-urlencoded\" or \"multipart/formdata\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "eventsource", "in" : "query", "description" : "The id of an existing event from which fields for the new event will be copied", "schema" : { "type" : "string" }, "example" : 13658130 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/AddEventForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/AddEventForm" } } } }, "responses" : { "200" : { "description" : "Event Created. | Event Copied.", "content" : { "application/json" : { "examples" : { "Create a Webinar" : { "description" : "Create a Webinar", "value" : { "wccevent" : { "eventId" : 1418636, "title" : "Event created from API", "eventAbstract" : "Event Abstract Sample", "promotionalSummary" : "Event Promotional Summary Sample", "liveStart" : "12/20/2017 08:45 AM", "liveDuration" : 3600, "liveEnd" : "12/20/2017 10:00 AM", "archiveStart" : "12/20/2017 10:30 AM", "archiveEnd" : "12/20/2018 10:30 AM", "clientId" : 4467, "timeZone" : "America/Los_Angeles", "eventType" : "webcam", "goodAfter" : "12/20/2017 09:00 AM", "audienceUrl" : "https://event.on24.com/wcc/r/1418636/15545789BB2677BD0FB3F6FAA3F8B557", "reportsUrl" : "https://api.on24.com/webcast/report?e=1418636&k=93263D3E106F0243316315BE767D8550", "previewUrl" : "http://api.on24.com/webcast/previewlobby?e=1418636&k=93263D3E106F0243316315BE767D8550", "archiveDuration" : 525600, "shortTimeZone" : "PST", "isLiveStartPast" : false, "isLiveEndPast" : false, "archiveEndInPast" : false, "monthsAvailableToExtend" : -1, "canExtendArchive" : false, "archiveAvailable" : true, "autoArchiveProcessed" : false, "canManipulateArchive" : false, "canToggleArchiveAvailability" : true, "showFaaBridgeNumber" : true, "showColossusLink" : true, "languageCd" : "en", "countryCd" : "UK", "sourceEventId" : 0, "rolloverAudio" : false, "rolloverAudioDisabled" : false, "tags" : [ "tag1", "tag2" ], "customaccounttags" : [ { "groupid" : 101, "groupname" : "Group 1", "tagid" : 741, "tagname" : "Option 1-A" }, { "groupid" : 102, "groupname" : "Group 2", "tagid" : 744, "tagname" : "Option 2-A" } ], "defaultPlayerConsoleTemplateId" : 0, "simuliveWaitingMode" : false, "PMUrl" : "https://api.on24.com/webcast/present?e=1418636&k=93263D3E106F0243316315BE767D8550", "simuliveEPMode" : true, "simuliveMode" : false, "hybrid" : "Y", "venue" : "Test Venue", "address" : "Test Address", "testevent" : "Y" } } }, "Copy a Webinar" : { "description" : "Copy a Webinar", "value" : { "wccevent" : { "eventId" : 1418636, "title" : "Copy of Event Created from API", "eventAbstract" : "Event Abstract Sample", "promotionalSummary" : "Event Promotional Summary Sample", "liveStart" : "12/20/2017 08:45 AM", "liveDuration" : 3600, "liveEnd" : "12/20/2017 10:00 AM", "archiveStart" : "12/20/2017 10:30 AM", "archiveEnd" : "12/20/2018 10:30 AM", "clientId" : 4467, "timeZone" : "America/Los_Angeles", "eventType" : "webcam", "goodAfter" : "12/20/2017 09:00 AM", "audienceUrl" : "https://event.on24.com/wcc/r/1418636/15545789BB2677BD0FB3F6FAA3F8B557", "reportsUrl" : "https://api.on24.com/webcast/report?e=1418636&k=93263D3E106F0243316315BE767D8550", "previewUrl" : "http://api.on24.com/webcast/previewlobby?e=1418636&k=93263D3E106F0243316315BE767D8550", "archiveDuration" : 525600, "shortTimeZone" : "PST", "isLiveStartPast" : false, "isLiveEndPast" : false, "archiveEndInPast" : false, "monthsAvailableToExtend" : -1, "canExtendArchive" : false, "archiveAvailable" : true, "autoArchiveProcessed" : false, "canManipulateArchive" : false, "canToggleArchiveAvailability" : true, "showFaaBridgeNumber" : true, "showColossusLink" : true, "languageCd" : "en", "countryCd" : "", "sourceEventId" : 0, "rolloverAudio" : false, "rolloverAudioDisabled" : false, "tags" : [ "tag1", "tag2" ], "customaccounttags" : [ { "groupid" : 101, "groupname" : "Group 1", "tagid" : 741, "tagname" : "Option 1-A" }, { "groupid" : 102, "groupname" : "Group 2", "tagid" : 744, "tagname" : "Option 2-A" } ], "defaultPlayerConsoleTemplateId" : 0, "simuliveWaitingMode" : false, "PMUrl" : "https://api.on24.com/webcast/present?e=1418636&k=93263D3E106F0243316315BE767D8550", "simuliveEPMode" : true, "simuliveMode" : false, "hybrid" : "Y", "venue" : "Test Venue", "address" : "Test Address", "testevent" : "Y" } } }, "Broadcast Video (encoder fragment)" : { "description" : "If the event is configured as Broadcast Video type, the response will include encoder information similar as following sample fragment:", "value" : { "encoders" : [ { "encoder" : "Encoder A", "url" : "rtmp://fmseosa.on24.com/liveeosa", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_A" }, { "encoder" : "Encoder B", "url" : "rtmp://fmseosb.on24.com/liveeosb", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_B" } ] } } } } } }, "400" : { "description" : "Webinar was not created due to errors in the parameters" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | Creating an event in a Global Client Account is not allowed. | Copying an event into a Global Client Account is not allowed." }, "404" : { "description" : "The client {clientId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Metadata and Usage", "description" : "Return information and summary activity about a particular event.\n\n- If double opt-in verification was enabled at the time of registration for an event and a user has not completed the verification process, the user will not be included in the eventanalytics section of the response (totalregistrants, noshowcount).", "operationId" : "AnalyticsEventLevel.MetadataAndUsage", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return information for an event.\n\n- **noshowcount** (calculated as **totalregistrants** - **totalattendees**) indicates the number of anonymous users who did not completed the registration for a particular event.", "content" : { "application/json" : { "examples" : { "When content type is webcast" : { "description" : "When content type is webcast", "value" : { "eventanalytics" : { "totalregistrants" : 10, "totalattendees" : 9, "liveattendees" : 0, "ondemandattendees" : 9, "numberofquestionsasked" : 0, "numberofquestionsanswered" : 0, "numberofpollspushed" : 2, "numberofpollresponses" : 0, "numberofsurveyspresented" : 2, "numberofsurveyresponses" : 0, "noshowcount" : 1, "registrationpagehits" : 4, "sharethiswidgetuniqueviews" : 2, "sharethiswidgettotalviews" : 3, "twitterwidgetuniqueviews" : 1, "twitterwidgettotalviews" : 8, "numberofctaclicks" : 3, "numberofmeetingconversions" : 3, "numberofdemoconversions" : 2, "numberoffreetrialrequests" : 1, "numberofdrifts" : 1, "numberofgroupchatmessagessubmitted" : 10, "numberofresourcesavailable" : 3, "attendeeswhodownloadedresource" : 1, "uniqueattendeeresourcedownloads" : 2, "eventengagementscore" : 1.7, "numberoftestssubmitted" : 10, "numberoftestspassed" : 8, "averageliveminutes" : 8, "averagecumulativeliveminutes" : 5, "averagearchiveminutes" : 3, "averagecumulativearchiveminutes" : 2, "totalcumulativeliveminutes" : 36, "totalcumulativearchiveminutes" : 0, "totalcumulativeminutes" : 36, "totalmediaplayerminutes" : 36, "totallivemediaplayerminutes" : 36, "totalarchivemediaplayerminutes" : 0 }, "eventid" : 10432146, "eventname" : "event Abstract", "clientid" : 22950, "eventduration" : 45, "goodafter" : "2016-10-18T04:35:00-07:00", "isactive" : true, "goodtill" : "2018-09-12T19:15:48-07:00", "regrequired" : true, "description" : "New Webcast", "promotionalsummary" : "Promotional Summary Sample", "regnotificationrequired" : true, "displaytimezonecd" : "America/Los_Angeles", "qandaemail" : "abhijeet.joshi@lmsin.com", "eventlocation" : "campaignCode31536770910802", "eventtype" : "Broadcast Video", "category" : "Marketing", "servicetype" : "Full Service", "sponsor" : "Ernst & Young", "createtimestamp" : "2016-10-18T04:34:06-07:00", "keyword" : "Wired and wireless network, network architecture, IT Professionals, merger or acquisition", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2016-10-18T04:34:06-07:00", "lastupdated" : "2016-10-20T09:58:12-07:00", "iseliteexpired" : "N", "application" : "Investor Relations", "industry" : "Software", "livestart" : "2016-10-18T04:20:00-07:00", "liveend" : "2016-10-18T05:20:00-07:00", "archivestart" : "2016-10-18T06:30:00-07:00", "archiveend" : "2017-10-18T06:30:00-07:00", "scheduledeventduration" : 60, "eventprofile" : "Stonehenge Profile (918)", "streamtype" : "video", "audiencekey" : "9AB4ABD834D841E9E5ED9124D266848B", "extaudienceurl" : "www.google.com", "reporturl" : "https://data.on24.com/webcast/report?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237", "uploadurl" : "https://wcc.on24.com/webcast/login", "pmurl" : "https://wcc.on24.com/webcast/present?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237", "previewurl" : "http://event.on24.com/webcast/previewlobby?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237", "audienceurl" : "https://event.on24.com/wcc/r/10432146/9AB4ABD834D841E9E5ED9124D266848B", "singlefilearchive" : "https://wccdownload.on24.com/event/92/45/75/96/rt/1_8C2F9DE3B5BD3AF93E297B37F1062EA6.mp4", "presentermediavideofile" : "https://wccdownload.on24.com/media/cv/events/92/45/75/96/rt/1_fhvideo1_1683630889731.mp4?filename=1_fhvideo1_1683630889731.mp4", "presentermediaaudiofile" : "https://wccdownload.on24.com/media/cv/events/92/45/75/96/rt/1683630889731.wav?filename=1683630889731.wav", "contenttype" : "webcast", "ishybridevent" : true, "partnerrefstats" : [ { "code" : "-", "count" : 2 } ], "tags" : [ "custom tag 1", "custom tag 2", "custom tag 3" ], "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "speakers" : [ { "name" : "Matthew Parfitt", "title" : "President", "company" : "Vulture US", "description" : "As President of Vuture in North America, Matt focuses on marketing communications in the legal sector which 4 years ago saw him launch Vuture in the USA. Matt is a regular speaker and active member of the LMA and has been chair the New York CRM group for the last 3 years." }, { "name" : "Samantha McKenna", "title" : "Director of Sales", "company" : "ON24 Inc.", "description" : "As Director of Sales, Samantha McKenna heads up the strategy behind ON24's legal presence. A thought leader in the legal industry, Sam works directly with ON24's legal clients on their go-to-market strategy for webinars, thought leadership events, virtual learning environments and virtual communications for alumni relations. She has served the legal community by attending the last seven Legal Marketing Association annual conferences, supporting several LMA chapters with sponsorships and by working directly with LMA on their national webinars as of 2015." } ], "encoders" : [ { "encoder" : "Encoder A", "url" : "rtmp://fmseosa.on24.com/liveeosa", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_A" }, { "encoder" : "Encoder B", "url" : "rtmp://fmseosb.on24.com/liveeosb", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_B" } ], "eventstd1" : "EF1", "eventstd2" : "EF2", "eventstd3" : "EF3", "eventstd4" : "EF4", "eventstd5" : "EF5", "surveyurls" : [ "https://eventqa.on24.com/eventManager/presentation/survey.jsp?eventId=10432146&sessionid=1&key=C9E1154B35A0AE0F3AF2858E25EA5509&survey=survey1" ], "customaccounttags" : [ { "groupid" : 103, "groupname" : "Group 3", "tagid" : 747, "tagname" : "Option 3-A" } ], "customeventfields" : [ { "name" : "custom1", "label" : "Region", "value" : "North America" }, { "name" : "custom2", "label" : "Org", "value" : "Research" }, { "name" : "custom3", "label" : "CRM Campaign Code", "value" : "111" }, { "name" : "custom4", "label" : "MAP Campaign Code", "value" : "222" }, { "name" : "custom5", "label" : "Product", "value" : "Computer" } ], "socialsharingimage" : "https://eventqa.on24.com/event/85/07/24/25/rt/1/images/socialsharing/socialsharing.jpg", "socialsharingabstract" : "Social Sharing Sample.", "istestevent" : "falseCopy to clipboard" } }, "When content type is gateway" : { "description" : "When content type is gateway", "value" : { "eventanalytics" : { "totalregistrants" : 6, "totalattendees" : 14, "noshowcount" : -8, "pageviews" : 88, "contentviews" : 10, "subscribers" : 3, "numberofcontactusrequests" : 3, "numberofgetpricingrequests" : 3, "numberoffreetrialrequests" : 1, "numberofdrifts" : 1, "numberofmeetingconversions" : 3, "numberofdemoconversions" : 7 }, "eventid" : 5001321, "clientid" : 22950, "description" : "New Content Gateway", "displaytimezonecd" : "US/Pacific", "localelanguagecd" : "zh", "localecountrycd" : "TW", "createtimestamp" : "2018-12-21T08:34:51-08:00", "publishedtimestamp" : "2019-02-21T10:11:03-08:00", "lastmodified" : "2019-09-03T14:34:18-07:00", "lastupdated" : "2019-09-05T09:58:12-07:00", "livestart" : "2018-12-21T08:34:51-08:00", "liveend" : "2018-12-21T08:34:51-08:00", "contenttype" : "gateway", "campaigncode" : "campaignCode31536770910802", "audienceurl" : "https://event.on24.com/r/5001321/A85228314568C6038E5F8D4AE3EFD890", "partnerrefstats" : [ { "code" : "-", "count" : 2 } ], "istestevent" : false } }, "When content type is experience" : { "description" : "When content type is experience", "value" : { "eventanalytics" : { "totalregistrants" : 4, "totalattendees" : 5, "ondemandattendees" : 5, "noshowcount" : -1, "registrationpagehits" : 6, "numberofmeetingconversions" : 3, "numberofdemoconversions" : 2, "numberofdrifts" : 1, "numberofcontactusrequests" : 1 }, "eventid" : 5000238, "eventduration" : 0, "clientid" : 29683, "goodafter" : "2018-12-20T00:40:00-08:00", "description" : "New Experience", "displaytimezonecd" : "US/Pacific", "eventtype" : "experience", "createtimestamp" : "2018-12-20T00:39:22-08:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2019-09-24T18:25:22-07:00", "lastupdated" : "2019-09-16T10:12:57-07:00", "livestart" : "2018-12-20T00:40:00-08:00", "liveend" : "2018-12-20T00:40:00-08:00", "audienceurl" : "https://gateway.on24.com/wcc/experience/Integrationca/1646442/5000238", "eventprofile" : "Gateway Experience Profile", "streamtype" : "audio", "contenttype" : "experience", "campaigncode" : "campaignCode31536770910802", "istestevent" : false } }, "When content type is video" : { "description" : "When content type is video", "value" : { "eventanalytics" : { "totalregistrants" : 10, "totalattendees" : 9, "ondemandattendees" : 9, "numberofpollspushed" : 3, "numberofpollresponses" : 6, "eventengagementscore" : 1.2 }, "eventid" : 5062231, "eventduration" : 2, "clientid" : 29683, "goodafter" : "2019-01-29T22:05:00-08:00", "description" : "New Video", "displaytimezonecd" : "America/Los_Angeles", "eventtype" : "video", "createtimestamp" : "2019-01-29T22:04:08-08:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2019-09-24T18:25:22-07:00", "lastupdated" : "2019-04-30T02:27:02-07:00", "livestart" : "2019-01-29T22:05:00-08:00", "liveend" : "2019-01-29T22:05:00-08:00", "eventprofile" : "Stonehenge Profile (1200)", "streamtype" : "video", "reporturl" : "https://data.on24.com/webcast/report?e=5062231&k=908F4DB78D30452A8B084FDC966CEFCD", "contenttype" : "video", "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "istestevent" : false } }, "When content type is pdf" : { "description" : "When content type is pdf", "value" : { "eventanalytics" : { "totalregistrants" : 6, "totalattendees" : 5, "ondemandattendees" : 5, "eventengagementscore" : 1.3 }, "eventid" : 5078145, "eventduration" : 0, "clientid" : 29683, "goodafter" : "2019-02-05T21:55:00-08:00", "description" : "New PDF", "displaytimezonecd" : "America/Los_Angeles", "eventtype" : "pdf", "createtimestamp" : "2019-02-05T21:54:55-08:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2019-09-24T18:25:22-07:00", "lastupdated" : "2019-02-08T05:55:47-08:00", "livestart" : "2019-02-05T21:55:00-08:00", "liveend" : "2019-02-05T21:55:00-08:00", "eventprofile" : "Stonehenge Profile (1200)", "streamtype" : "whitepaper", "reporturl" : "https://data.on24.com/webcast/report?e=5078145&k=1DB6F9E04F2A4821B7D3B7AB3889DFF1", "contenttype" : "pdf", "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "istestevent" : false } }, "When content type is webpage" : { "description" : "When content type is webpage", "value" : { "eventanalytics" : { "totalregistrants" : 3, "totalattendees" : 3, "ondemandattendees" : 3 }, "eventid" : 5463684, "eventduration" : 0, "clientid" : 29683, "goodafter" : "2019-08-08T23:32:00-07:00", "description" : "New Webpage", "displaytimezonecd" : "America/Los_Angeles", "eventtype" : "webpage", "createtimestamp" : "2019-08-08T23:31:21-07:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2019-09-24T18:25:22-07:00", "lastupdated" : "2019-08-09T03:42:00-07:00", "livestart" : "2019-08-08T23:32:00-07:00", "liveend" : "2019-08-08T23:32:00-07:00", "eventprofile" : "Stonehenge Profile (1200)", "streamtype" : "whitepaper", "contenttype" : "webpage", "funnelstages" : [ "Consideration", "Awareness", "Evaluation" ], "istestevent" : false } }, "VE Account" : { "description" : "VE Account", "value" : { "eventanalytics" : { "totalregistrants" : 10, "totalattendees" : 9, "noshowcount" : 1, "registrationpagehits" : 4, "numberofresourcesavailable" : 3, "numberofmeetingconversions" : 27, "numberofdemoconversions" : 3, "numberofgetpricingrequests" : 7, "numberoffreetrialrequests" : 11, "attendeeswhodownloadedresource" : 1, "uniqueattendeeresourcedownloads" : 2, "averagearchiveminutes" : 3, "averagecumulativearchiveminutes" : 2 }, "eventid" : 14031264, "eventname" : "event from VE account", "clientid" : 22957, "goodafter" : "2016-10-18T04:35:00-07:00", "isactive" : true, "goodtill" : "2018-09-12T19:15:48-07:00", "regrequired" : true, "description" : "Test VE Event", "promotionalsummary" : "Promotional Summary Sample", "displaytimezonecd" : "America/Los_Angeles", "campaigncode" : "campaignCode31537670918020", "createtimestamp" : "2016-10-18T04:34:06-07:00", "lastmodified" : "2016-10-18T04:34:06-07:00", "lastupdated" : "2016-10-20T09:58:12-07:00", "livestart" : "2016-10-18T04:20:00-07:00", "liveend" : "2016-10-18T05:20:00-07:00", "archivestart" : "2016-10-18T06:30:00-07:00", "archiveend" : "2017-10-18T06:30:00-07:00", "reporturl" : "https://data.on24.com/webcast/report?e=14031264&k=A8EBCD7A76D8BF36D71DCFEBED688237", "audienceurl" : "https://event.on24.com/wcc/r/14031264/9AB4ABD834D841E9E5ED9124D266848B", "contenttype" : "virtualenvironment", "partnerrefstats" : [ { "code" : "-", "count" : 2 } ], "istestevent" : false } }, "When content type is golive" : { "description" : "When content type is golive", "value" : { "eventanalytics" : { "totalregistrants" : 3, "totalattendees" : 2, "ondemandattendees" : 2 }, "eventid" : 10341265, "eventduration" : 45, "clientid" : 22950, "goodafter" : "2021-10-01T04:35:00-07:00", "isactive" : true, "goodtill" : "2021-10-02T19:15:48-07:00", "regrequired" : false, "description" : "Go Live Sample", "regnotificationrequired" : true, "displaytimezonecd" : "America/Los_Angeles", "campaigncode" : "Campaign_Code_Sample", "eventtype" : "Go Live", "createtimestamp" : "2021-09-01T04:34:06-07:00", "localelanguagecd" : "zh", "localecountrycd" : "TW", "lastmodified" : "2021-09-02T04:34:06-07:00", "lastupdated" : "2021-09-20T09:58:12-07:00", "livestart" : "2021-10-01T04:20:00-07:00", "liveend" : "2021-10-02T05:20:00-07:00", "archivestart" : "2021-10-01T06:30:00-07:00", "archiveend" : "2022-10-01T06:30:00-07:00", "previewurl" : "https://golive.on24.com/event/10341265?previewmode=true", "audienceurl" : "https://golive.on24.com/event/10341265", "contenttype" : "golive", "categories" : [ "category 1", "category 2", "category 3" ], "tracks" : [ "track 1", "track 2", "track 3" ], "categoriesdata" : [ { "id" : 21, "name" : "category 1" }, { "id" : 22, "name" : "category 2" }, { "id" : 23, "name" : "category 3" } ], "trackdata" : [ { "id" : 11, "name" : "track 1" }, { "id" : 12, "name" : "track 2" }, { "id" : 13, "name" : "track 3" } ], "livedays" : [ { "id" : 66, "title" : "LIVE DAY 1", "livestarttime" : "2021-10-01T03:35:00-07:00", "liveendtime" : "2021-10-01T03:40:00-07:00" } ], "contents" : [ { "title" : "content name", "type" : "Breakout", "status" : "published", "url" : "http://www.on24.com" }, { "title" : "Opening Keynote", "type" : "webcast", "status" : "Published", "resourceid" : 1234567, "sessionstarttime" : "2026-04-02T08:15:00-07:00", "eventid" : 4567890, "livedayid" : 1001, "tracks" : [ { "id" : 11, "name" : "track 1" }, { "id" : 12, "name" : "track 2" } ], "categories" : [ { "id" : 21, "name" : "category 1" }, { "id" : 22, "name" : "category 2" } ] } ], "speakers" : [ { "name" : "Speaker Sample", "title" : "Mr.", "company" : "CO", "description" : "Speaker BIO sample." } ], "sponsors" : [ { "id" : 118, "name" : "Sponsor A", "staff" : [ { "firstname" : "Jim", "lastname" : "Darnald", "company" : "Company Name", "title" : "Sr. Manager", "email" : "jim.darnald@test.com", "roles" : [ "Admin", "Rep" ] } ] } ], "istestevent" : false } }, "Broadcast Video (encoder fragment)" : { "description" : "If the event is configured as Broadcast Video type, the response will include encoder information similar as following sample fragment:", "value" : { "encoders" : [ { "encoder" : "Encoder A", "url" : "rtmp://fmseosa.on24.com/liveeosa", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_A" }, { "encoder" : "Encoder B", "url" : "rtmp://fmseosb.on24.com/liveeosb", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_B" } ] } } } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } }, "put" : { "tags" : [ "Event Management" ], "summary" : "Update a Webinar", "description" : "Updates a webinar.\n\n- **liveDuration** parameter conditions:\n - When copying a webinar, users are able to provide a liveDuration value in 15 minute increments (e.g. 15, 30, 45, 60, etc.) up to 120 minutes.\n - Above 120 minutes, increments will be 30 minutes up to 480 minutes.\n - The maximum allowed liveDuration is 480 minutes.\n- **liveStart** accepted date/time formats:\n - **MM/DD/YYYY hh:mm a** (08/26/2016 09:00 AM)\n - **YYYY-MM-DDThh:mm:ss** Default timezone will be Pacific Time. (2016-08-26T09:00:00)\n - **YYYY-MM-DDThh:mm:ss±zz:zz** where ±zz:zz is timezone's offset (2016-08-26T09:00:00-07:00)\n - JavaScript Date.toString() format is also supported (Wed Apr 04 2018 16:12:41 GMT+0200 (CEST) )\n- **tagCampaign** parameter conditions:\n - When copying a webinar users are allowed to add up to 10 custom tags via the tagCampaign parameter.\n - Every tag that is associated with the webinar should be available in the **tags** array field in the response.\n - The following characters can not be used and will result in an error: £$!%&*()}{@#~?><',\"|=_+¬\n- **customAccountTag** parameter conditions:\n - Supported only for client accounts with enabled custom account tags.\n - When copying a webinar for an account with enabled custom account tags, users are allowed to add up to 3 tag IDs\n - Provided values must match configured client account values.\n- **languageCd** / **countryCd** parameters conditions:\n - Following are allowed pairs of language/country values when copying an event:\n - Chinese (Simplified): languageCd=**\"zh\"**, countryCd=**\"CN\"**\n - Chinese (Traditional): languageCd=**\"zh\"**, countryCd=**\"TW\"**\n - English (UK): languageCd=**\"en\"**, countryCd=**\"UK\"**\n - For other languages, No countryCd is allowed.\n\n## Conditions & Restrictions\nIn order to update a webinar, certain contitions must be met.\n\n- title, languageCd, countryCd and campaignCode can be modified at any time\n- liveStart, liveDuration and eventType can be modified 2 or more hours before the event starts.\n- liveStart can not be modified to a time within the next 2 hours\n- Supported event types:\n - screenshare\n - webcam\n - microphone\n - ondemand\n - simulive\n - encodeonsite\n - sim2live\n - fav\n - FABNoScreenShare\n- eventType can not be changed for ondemand events\n- simulive events can be only changed into sim2live\n- sim2live events can be only changed into simulive\n\n- eventType can not be modified to ondemand, simulive and sim2live\n- liveDuration can not be changed for ondemand and simulive events\n- For events with associated countryCd, if the provided languageCd does not support countryCd and no countryCd is provided in the request, the country code is set as empty.\n- countryCd is validated against the provided or existent languageCd. (Example. if the languageCd is 'zh' the possible values are: CN|TW)", "operationId" : "EventManagement.UpdateAWebinar", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "Possible values: \"application/x-www-form-urlencoded\" or \"multipart/formdata\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/UpdateEventForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/UpdateEventForm" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "examples" : { "Update a Webinar" : { "description" : "Update a Webinar", "value" : { "wccevent" : { "eventId" : 10465031, "title" : "Update-webinar-sample", "eventAbstract" : "Event Abstract Sample", "promotionalSummary" : "Event Promotional Summary Sample", "liveStart" : "01/18/2018 04:45 PM", "liveDuration" : 28800, "liveEnd" : "01/19/2018 01:00 AM", "archiveStart" : "01/19/2018 01:30 AM", "archiveEnd" : "01/19/2019 01:30 AM", "clientId" : 22921, "timeZone" : "America/Bogota", "eventType" : "screenshare", "goodAfter" : "01/18/2018 05:00 PM", "dialInNumber" : "415-481-6017 (FAA - Other Number), 415-481-6017 (FAA)", "bridgeDialInNumber" : "415-481-6020 (FAB - Other Number), 415-481-6020 (FAB)", "dialInPasscode" : "92871", "audienceUrl" : "https://eventqa.on24.com/wcc/r/10465031/0815FD5E87267F2622A1829961F89D5C", "reportsUrl" : "https://wccqa.on24.com/webcast/report?e=10465031&k=A1F5A9389875B909D496FED49C1581FE", "previewUrl" : "https://wccqa.on24.com/webcast/previewlobby?e=10465031&k=A1F5A9389875B909D496FED49C1581FE", "archiveDuration" : 525600, "shortTimeZone" : " COT", "isLiveStartPast" : false, "isLiveEndPast" : false, "archiveEndInPast" : false, "monthsAvailableToExtend" : -1, "canExtendArchive" : false, "archiveAvailable" : true, "autoArchiveProcessed" : false, "canManipulateArchive" : false, "canToggleArchiveAvailability" : true, "showFaaBridgeNumber" : false, "showColossusLink" : false, "languageCd" : "en", "countryCd" : "UK", "campaignCode" : "Code Updated", "sourceEventId" : 0, "rolloverAudio" : false, "rolloverAudioDisabled" : false, "tags" : [ "tag1", "tag2" ], "customaccounttags" : [ { "groupid" : 101, "groupname" : "Group 1", "tagid" : 741, "tagname" : "Option 1-A" }, { "groupid" : 102, "groupname" : "Group 2", "tagid" : 744, "tagname" : "Option 2-A" } ], "defaultPlayerConsoleTemplateId" : 0, "simuliveWaitingMode" : false, "pmurl" : "https://wccqa.on24.com/webcast/present?e=10465031&k=A1F5A9389875B909D496FED49C1581FE", "simuliveEPMode" : false, "simuliveMode" : false } } }, "Broadcast Video (encoder fragment)" : { "description" : "If the event is configured as Broadcast Video type, the response will include encoder information similar as following sample fragment:", "value" : { "encoders" : [ { "encoder" : "Encoder A", "url" : "rtmp://fmseosa.on24.com/liveeosa", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_A" }, { "encoder" : "Encoder B", "url" : "rtmp://fmseosb.on24.com/liveeosb", "streamid" : "5439654_1_fhvideo1_CA6701A4E974D5F01F1658BAD56EC63F_B" } ] } } } } } }, "400" : { "description" : "Webinar was not created due to errors in the parameters" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist." } } }, "delete" : { "tags" : [ "Event Management" ], "summary" : "Delete Webinar", "description" : "Deletes a webinar.", "operationId" : "EventManagement.DeleteWebinar", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Event Deleted.", "content" : { "application/json" : { "example" : { "message" : "Event Successfully Deleted." } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "You don't have access to this client id; or You don't have ability to delete this event; or You reached the maximum number of calls for this endpoint" }, "404" : { "description" : "Event not found for this client or its children" }, "410" : { "description" : "Event has already been deleted" }, "412" : { "description" : "Event does not meet criteria for deletion" } } } }, "/client/{clientId}/event/{eventId}/attendee" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Attendees", "description" : "Returns a list of attendees for a particular event. All dates and times are in Pacific Time.\n\n- **dateFilterMode** parameter options (not case-sensitive):\n - If the parameter is not included or no value is supplied, **startDate** and **endDate** will work in the manner they usually do.\n - \"lastActivity\" is the only supported value. When passed, the response will include only those attendees who have had activity between (and including) the provided **startDate** and **endDate**. Attendee lastActivity value is updated with new modified date whenever one of the following actions is performed by an attendee:\n - Starting new session\n - Refreshing browser during webcast presentation\n - Submitting poll answers", "operationId" : "AnalyticsEventLevel.Attendees", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "dateInterval", "in" : "query", "description" : "Number of days returned in a response. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64" }, "example" : 30 }, { "name" : "dateIntervalOffset", "in" : "query", "description" : "Number of days from which the interval should encompass. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 4 }, { "name" : "dateIntervalTimezone", "in" : "query", "description" : "Timezone to be used for determining the 24 hour period that constitutes a day. See Rolling Interval.", "schema" : { "type" : "string", "default" : "America/Los_Angeles" }, "example" : "America/Los_Angeles" }, { "name" : "startdate", "in" : "query", "description" : "Limit results to those with attendee activity after startDate", "schema" : { "type" : "string" }, "example" : "2017-12-31" }, { "name" : "enddate", "in" : "query", "description" : "Limit results to those with attendee activity before endDate", "schema" : { "type" : "string" }, "example" : "2017-12-31" }, { "name" : "partnerref", "in" : "query", "description" : "Filter by partnerref", "schema" : { "type" : "string" }, "example" : "EM" }, { "name" : "userstatus", "in" : "query", "description" : "Filter to users based on their status. If not provided, only regular users will be returned. Possible values: any: will return all registrants, including: active, soft-deleted and forgotten registrants. deleted: will return soft-deleted users only. forgotten: will return forgotten users only. **Note:** By design, there is No option to exclude soft-deleted users from the response.", "schema" : { "type" : "string", "default" : "any" }, "example" : "any" }, { "name" : "filterforgotten", "in" : "query", "description" : "**Deprecated** - Forgotten registrants filter. Y: only forgotten users will be returned in the response. N: forgotten users will be omitted in the response.", "schema" : { "type" : "string", "default" : "N" }, "example" : "Y" }, { "name" : "excludeanonymous", "in" : "query", "description" : "**Deprecated** - System-Generated (anonymous) email addresses are now always excluded from responses. This parameter is retained for backward compatibility but no longer affects the result set.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "Y" }, { "name" : "datefiltermode", "in" : "query", "description" : "Type of date to be used with the startDate and endDate parameters.", "schema" : { "type" : "string" }, "example" : "lastActivity" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of attendees for an event\n\n- Values for fields **liveminutes**, **archiveminutes**, **cumulativeliveminutes** and **cumulativearchiveminutes** are rounded to the closest integer value (e.g. 2.316 is returned as 2, 3.542 is returned as 4). If an attendee's actual viewing minutes are greater than 0 and less than 1, response will return 1 as the value (e.g. 0.123 is returned as 1).\n- The following values are cached on the server between 3 - 24 hours:\n - engagementscore", "content" : { "application/json" : { "examples" : { "Elite account" : { "description" : "Elite account", "value" : { "eventid" : 311512, "totalattendees" : 1, "attendees" : [ { "email" : "xxxxxxxx@on24.com", "eventuserid" : 49502149, "exteventusercd" : "1502", "userstatus" : "active", "isblocked" : "N", "engagementscore" : 8.5, "liveminutes" : 40, "liveviewed" : 1, "firstliveactivity" : "2015-05-19T11:01:42-07:00", "lastliveactivity" : "2015-05-19T11:41:42-07:00", "archiveminutes" : 120, "archiveviewed" : 2, "firstarchiveactivity" : "2015-05-19T06:14:17-07:00", "lastarchiveactivity" : "2015-05-19T09:20:48-08:00", "askedquestions" : 2, "resourcesdownloaded" : 2, "answeredpolls" : 2, "answeredsurveys" : 2, "answeredsurveyquestions" : 4, "launchmode" : "At the Venue", "questions" : [ { "questionid" : 6268255, "createtimestamp" : "2015-05-19T11:55:12-07:00", "content" : "What happens if I forget my password?", "answer" : { "createtimestamp" : "2015-05-19T11:57:12-07:00", "content" : "Customer service will email you instructions for getting a new password", "presenterid" : 813717, "presentername" : "Mark XXXXX", "privacy" : "Private" } }, { "questionid" : 6268257, "createtimestamp" : "2015-05-19T11:58:12-07:00", "content" : "Can you use the tool to send SMS texts directly?", "answer" : { "createtimestamp" : "2015-05-19T11:59:59-07:00", "content" : "No, although you can set up a Twitter hashtag for an event", "presenterid" : 813706, "presentername" : "Steve XXXXX", "privacy" : "Private" } } ], "polls" : [ { "pollid" : 16818601, "pollsubmittedtimestamp" : "2015-05-19T11:45:12-07:00", "pollquestionid" : 6268336, "pollquestion" : "Which products are you interested in? (select all that apply)", "pollanswers" : [ "Full Service Webcasts" ], "pollanswersdetail" : [ { "answercode" : "choice1", "answer" : "Full Service Webcasts" } ] }, { "pollid" : 16818630, "pollsubmittedtimestamp" : "2015-05-19T11:47:12-07:00", "pollquestionid" : 6268358, "pollquestion" : "How familiar are you with virtual event solutions?", "pollanswers" : [ "Unfamiliar" ], "pollanswersdetail" : [ { "answercode" : "choice1", "answer" : "Unfamiliar" } ] } ], "resources" : [ { "resourceid" : 16836843, "resourceviewed" : "Frost and Sullivan 2012", "resourceviewedtimestamp" : "2015-05-19T12:05:02-07:00" }, { "resourceid" : 16836837, "resourceviewed" : "5 keys to webcasting", "resourceviewedtimestamp" : "2015-05-19T12:15:37-07:00" } ], "surveys" : [ { "surveyid" : "311512_survey1", "surveysubmittedtimestamp" : "2015-05-19T11:49:12-07:00", "surveyquestions" : [ { "surveyquestionid" : 6268293, "surveyquestion" : "How valuable was the information presented?", "questioncode" : "110", "primaryquestioncode" : "110", "surveyanswers" : [ "Not Valuable at all" ], "surveyanswersdetail" : [ { "answercode" : "choice1", "answer" : "Not Valuable at all" } ] }, { "surveyquestionid" : 6268271, "surveyquestion" : "What industry are you in?", "surveyanswers" : [ "Food& Beverage" ], "surveyanswersdetail" : [ { "answercode" : "choice1", "answer" : "Food& Beverage" } ] } ] }, { "surveyid" : "311512_survey2", "surveysubmittedtimestamp" : "2015-05-19T11:51:12-07:00", "surveyquestions" : [ { "surveyquestionid" : 6268306, "surveyquestion" : "Would you like a 1:1 session with an expert?", "surveyanswers" : [ "No" ], "surveyanswersdetail" : [ { "answercode" : "choice1", "answer" : "No" } ] }, { "surveyquestionid" : 6268299, "surveyquestion" : "Which tools are you using today?", "questioncode" : "235", "primaryquestioncode" : "234", "surveyanswers" : [ "Webex" ], "surveyanswersdetail" : [ { "answercode" : "choice1", "answer" : "Webex" } ] } ] } ], "twitterwidget" : [ { "date" : "2015-05-19T11:02:39-07:00", "tweetdescription" : "A new Webinar on Artificial Intelligence has been scheduled. Check www.on24.com/eventschedule" } ], "calltoactions" : [ { "ctaid" : "83970357", "ctaname" : "Call To Action 1", "clicks" : "3", "action" : "https://www.calltoactionurl.com", "date" : "2015-05-19T11:10:00-07:00" } ], "testwidgets" : [ { "testwidgetresult" : "P", "retries" : 0, "correctanswersneeded" : 2, "correctanswersprovided" : 2 } ], "testwidgetresult" : "P", "certificationwidgetresult" : "C", "certificationcredit" : "NR", "certificationtimestamp" : "2015-05-19T12:29:41-07:00", "userprofileurl" : "https://dataqa.on24.com/webcast/lead?token=bEXeTgJ6Y3qWV0hrUSTYW_y2Nlwkx9EiC7UTDo-N6Ler9Nwy34-qz2C-iXx_ejsO7EWvjLE-BRqxO1-mFbLpq4cF99i1M7dmCqVvCrw=", "campaigncode" : "CPM-001", "sourcecampaigncode" : "CMP-001", "sourceeventid" : 2141380, "cumulativeliveminutes" : 40, "cumulativearchiveminutes" : 120, "partnerref" : "registered_partner", "attendancepartnerref" : "last_partner", "attendeesessions" : 4, "certifications" : [ { "certificationid" : 83328985, "certificationresult" : "C", "certificationname" : "Certification 1", "certificationcredit" : "NR", "certificationtimestamp" : "2015-05-19T12:29:41-07:00", "certificationurl" : "https://event.on24.com/ceCertficate/26/18/35/24/2/certificate_83328985.pdf" } ], "meetingconversions" : [ { "widgetid" : "98533828", "widgetname" : "Book a Meeting Sample", "widgettype" : "book_a_meeting", "widgetaction" : "https://www.bookedmeeting.com", "widgetsubmittedtimestamp" : "2016-01-01T10:00:23-07:00" } ], "democonversions" : [ { "widgetid" : "98533852", "widgetname" : "Schedule a Demo Sample", "widgettype" : "request_a_demo", "widgetaction" : "jane.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:00:23-07:00" } ], "freetrial" : [ { "widgetid" : "93838564", "widgetname" : "Free Trial Sample", "widgettype" : "free_trial", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ], "contactus" : [ { "widgetid" : "7884", "widgetname" : "Contact us 1", "widgettype" : "contactus", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2015-05-20T11:18:13-07:00" } ], "drift" : [ { "widgetid" : "93858367", "widgetname" : "startConversation", "widgettype" : "drift", "widgetaction" : "Jan 01, 2016 10:00 AM", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ], "breakouts" : [ { "breakoutid" : "4816", "breakoutname" : "Breakout Room Sample", "breakoutrole" : "Attendee", "breakoutcumulativeliveminutes" : 15 } ], "calendly" : [ { "meetingsbooked" : 2 } ], "shareidea" : [ { "topic" : "What are the best colors?", "type" : "IDEA", "description" : "Blue", "ideanumber" : 66628, "rating" : 1, "datetime" : "2024-07-26T07:38:51-07:00" }, { "topic" : "How can we increase our audience engagement?", "type" : "COMMENT", "description" : "By providing relevant and exciting information.", "ideanumber" : 66627, "datetime" : "2024-07-26T07:37:24-07:00" } ], "reactions" : [ { "type" : "celebrate", "timefromstart" : 9, "datetime" : "2024-06-16T23:40:40-07:00" }, { "type" : "laugh", "timefromstart" : 7, "datetime" : "2024-06-16T23:40:38-07:00" }, { "type" : "heart", "timefromstart" : 6, "datetime" : "2024-06-16T23:40:37-07:00" }, { "type" : "like", "timefromstart" : 4, "datetime" : "2024-06-16T23:40:35-07:00" } ], "livemediaplayerminutes" : 40, "archivemediaplayerminutes" : 40 } ] } }, "When content type is gateway" : { "description" : "When content type is gateway", "value" : { "eventid" : 311513, "totalattendees" : 1, "attendees" : [ { "email" : "xxxxxxxx@ehub.com", "eventuserid" : 49502161, "exteventusercd" : "1504", "userstatus" : "active", "isblocked" : "N", "engagementscore" : 4.1, "liveminutes" : 15, "liveviewed" : 1, "archiveminutes" : 32, "archiveviewed" : 1, "firstarchiveactivity" : "2015-05-20T06:14:17-07:00", "lastarchiveactivity" : "2015-05-20T09:20:48-08:00", "askedquestions" : 0, "resourcesdownloaded" : 0, "answeredpolls" : 0, "answeredsurveys" : 0, "answeredsurveyquestions" : 0, "userprofileurl" : "https://dataqa.on24.com/webcast/lead?token=bEXeTgJ6Y3qWV0hrUSTYW_y2Nlwkx9EiC7UTDo-N6Ler9Nwy34-qz2C-iXx_ejsO7EWvjLE-BRqxO1-mFbLpq4cF99i1M7dmCqVvCrw=", "campaigncode" : "CPM-001", "sourcecampaigncode" : "CMP-001", "sourceeventid" : 2141380, "cumulativeliveminutes" : 0, "cumulativearchiveminutes" : 32, "partnerref" : "registered_partner", "attendancepartnerref" : "last_partner", "attendeesessions" : 1, "meetingconversions" : [ { "widgetid" : "8147", "widgetname" : "Book a Meeting 1", "widgettype" : "book_a_meeting", "widgetaction" : "https://www.ehub_bookedmeeting.com", "widgetsubmittedtimestamp" : "2015-05-20T10:05:23-07:00" } ], "democonversions" : [ { "widgetid" : "7895", "widgetname" : "Schedule a Demo 1", "widgettype" : "request_a_demo", "widgetaction" : "jane.doe@on24.com", "widgetsubmittedtimestamp" : "2015-05-20T11:21:00-07:00" } ], "contactus" : [ { "widgetid" : "7884", "widgetname" : "Contact us 1", "widgettype" : "contactus", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2015-05-20T11:18:13-07:00" } ], "getpricing" : [ { "widgetid" : 7891, "widgetname" : "Price Quote 1", "widgettype" : "price_quote", "widgetaction" : "https://www.google.com/", "widgetsubmittedtimestamp" : "2015-05-20T02:29:30-07:00" } ], "freetrial" : [ { "widgetid" : "93838564", "widgetname" : "Free Trial Sample", "widgettype" : "free_trial", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ], "drift" : [ { "widgetid" : "93858367", "widgetname" : "startConversation", "widgettype" : "drift", "widgetaction" : "Jan 01, 2016 10:00 AM", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ] } ] } }, "When content type is experience" : { "description" : "When content type is experience", "value" : { "eventid" : 311514, "totalattendees" : 1, "attendees" : [ { "email" : "xxxxxxxx@targetexperience.com", "eventuserid" : 49502162, "exteventusercd" : "1505", "userstatus" : "active", "isblocked" : "N", "engagementscore" : 4.1, "liveminutes" : 0, "archiveminutes" : 32, "archiveviewed" : 1, "firstarchiveactivity" : "2015-05-20T06:14:17-07:00", "lastarchiveactivity" : "2015-05-20T09:20:48-08:00", "askedquestions" : 0, "resourcesdownloaded" : 0, "answeredpolls" : 0, "answeredsurveys" : 0, "answeredsurveyquestions" : 0, "userprofileurl" : "https://dataqa.on24.com/webcast/lead?token=bEXeTgJ6Y3qWV0hrUSTYW_y2Nlwkx9EiC7UTDo-N6Ler9Nwy34-qz2C-iXx_ejsO7EWvjLE-BRqxO1-mFbLpq4cF99i1M7dmCqVvCrw=", "campaigncode" : "CPM-001", "sourcecampaigncode" : "CMP-001", "sourceeventid" : 2141380, "cumulativeliveminutes" : 0, "cumulativearchiveminutes" : 32, "partnerref" : "registered_partner", "attendancepartnerref" : "last_partner", "attendeesessions" : 1, "meetingconversions" : [ { "widgetid" : "98533828", "widgetname" : "Book a Meeting 1", "widgettype" : "book_a_meeting", "widgetaction" : "https://www.bookedmeeting.com", "widgetsubmittedtimestamp" : "2015-05-20T10:00:23-07:00" } ], "democonversions" : [ { "widgetid" : "98533852", "widgetname" : "Schedule a Demo 1", "widgettype" : "request_a_demo", "widgetaction" : "jane.doe@on24.com", "widgetsubmittedtimestamp" : "2015-05-20T11:00:23-07:00" } ], "contactus" : [ { "widgetid" : "98532583", "widgetname" : "Contact us 1", "widgettype" : "contactus", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2015-05-20T11:00:23-07:00" } ], "drift" : [ { "widgetid" : "93858367", "widgetname" : "startConversation", "widgettype" : "drift", "widgetaction" : "Jan 01, 2016 10:00 AM", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ] } ] } }, "VE account" : { "description" : "VE account", "value" : { "eventid" : 71883, "totalattendees" : 1, "attendees" : [ { "email" : "xxxxxxxxx@on24.com", "eventuserid" : 123375229, "clientid" : 2213, "exteventusercd" : "1502", "userstatus" : "active", "isblocked" : "N", "archiveminutes" : 7, "archiveviewed" : 1, "firstarchiveactivity" : "2020-01-20T23:59:38-08:00", "lastarchiveactivity" : "2020-01-20T23:59:38-08:00", "resourcesdownloaded" : 1, "answeredsurveys" : 1, "answeredsurveyquestions" : 1, "campaigncode" : "CPM-001", "sourcecampaigncode" : "CPM-001", "cumulativearchiveminutes" : 13, "attendeesessions" : 6, "locationsvisited" : 1, "resources" : [ { "resourceid" : 5626305, "resourceviewed" : "Customer Resource", "resourceviewedtimestamp" : "2020-01-21T00:02:29-08:00", "resourceviews" : 1, "resourcetype" : "WEBCAST", "sponsorid" : 223628, "sponsorname" : "Sponsor_1" } ], "surveys" : [ { "surveyid" : "6388264", "surveysubmittedtimestamp" : "2020-01-21T00:05:13-08:00", "surveyquestions" : [ { "surveyquestionid" : 987654, "surveyquestion" : "what is the number phi ?", "surveyanswers" : [ "It is the basis for the golden ratio: 1.618" ], "surveyanswersdetail" : [ { "answercode" : "choice1", "answer" : "It is the basis for the golden ratio: 1.618" } ] } ] } ], "locationvisits" : [ { "locationid" : 2, "locationcode" : "home", "locationname" : "Plaza", "sponsorid" : 0, "sponsorname" : "Environment-level", "visits" : 31, "visitsduration" : 44, "cumulativevisitsduration" : 44 } ], "meetingconversions" : [ { "widgetid" : "98358328", "widgetname" : "Book a Meeting Sample", "widgettype" : "book_a_meeting", "widgetaction" : "https://www.bookedmeeting.com", "widgetsubmittedtimestamp" : "2016-01-01T10:00:23-07:00" } ], "democonversions" : [ { "widgetid" : "98533852", "widgetname" : "Schedule a Demo Sample", "widgettype" : "request_a_demo", "widgetaction" : "jane.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:00:23-07:00" } ], "getpricing" : [ { "widgetid" : "93538823", "widgetname" : "Get Pricing Sample", "widgettype" : "get_pricing", "widgetaction" : "jane.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:05:23-07:00" } ], "freetrial" : [ { "widgetid" : "93838564", "widgetname" : "Free Trial Sample", "widgettype" : "free_trial", "widgetaction" : "john.doe@on24.com", "widgetsubmittedtimestamp" : "2016-01-01T11:07:23-07:00" } ] } ] } }, "When content type is golive" : { "description" : "When content type is golive", "value" : { "eventid" : 6958054, "totalattendees" : 1, "attendees" : [ { "email" : "xxxxxxxx@on24.com", "eventuserid" : 264677544, "userstatus" : "active", "isblocked" : "N", "engagementscore" : 0.0, "liveminutes" : 40, "liveviewed" : 1, "firstliveactivity" : "2021-10-01T05:55:22-08:00", "lastliveactivity" : "2021-10-02T11:41:42-07:00", "resourcesdownloaded" : 0, "answeredpolls" : 0, "sourceeventid" : 6958054, "userprofileurl" : "https://dataqa.on24.com/webcast/lead?token=bEXeTgJ6Y3qWV0hrUSTYW_y2Nlwkx9EiC7UTDo-N6Ler9Nwy34-qz2C-iXx_ejsO7EWvjLE-BRqxO1-mFbLpq4cF99i1M7dmCqVvCrw=", "cumulativeliveminutes" : 35, "attendeesessions" : 4 } ] } } } } } }, "400" : { "description" : "Error, incorrect date formats." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/attendeesession" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Attendee Viewing Sessions", "description" : "Returns a list of attendee viewing sessions for a particular event. All dates and times are in Pacific Time.\n\n**sessionType** supported values:\n- \"all\" (default)\n- \"live\"\n- \"ondemand\"\n- \"blocked\"", "operationId" : "AnalyticsEventLevel.AttendeeViewingSessions", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "sessiontype", "in" : "query", "description" : "Filter by session type", "schema" : { "type" : "string", "default" : "All" }, "example" : "ondemand" }, { "name" : "pageoffset", "in" : "query", "description" : "Number of page to retrieve", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 5 }, { "name" : "itemsperpage", "in" : "query", "description" : "Number of items to be retrieved per page", "schema" : { "type" : "integer", "format" : "int64", "default" : 100 }, "example" : 25 }, { "name" : "startdate", "in" : "query", "description" : "Limit results to sessions created from start Date", "schema" : { "type" : "string", "format" : "date" }, "example" : "2021-04-10" }, { "name" : "enddate", "in" : "query", "description" : "Limit results to sessions with last update until end Date. Default: current date if startDate was provided and endDate was not.", "schema" : { "type" : "string", "format" : "date", "default" : "Current date if startDate value was provided and endDate value was not provided" }, "example" : "2021-04-15" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of attendee viewing sessions for an event", "content" : { "application/json" : { "example" : { "totalattendeesessions" : 2, "pagecount" : 1, "currentpage" : 0, "attendeesession" : [ { "id" : 150332406, "email" : "oduser21march1@inbfw.com", "firstname" : "oduser21march1", "lastname" : "inbfw", "duration" : "00:00:13", "starttime" : "2018-03-21T03:06:53-07:00", "endtime" : "2018-03-21T03:07:06-07:00", "usage" : "Archived", "mediastream" : "Flash Audio", "os" : "win8.1", "browser" : "firefox58", "streamsource" : "https", "ipaddress" : "115.166.143.238", "exteventusercd" : "1502", "launchmode" : "At the Venue" }, { "id" : 150332447, "email" : "ieuser1@inbfw.com", "firstname" : "IEuser1", "lastname" : "inbfw", "duration" : "00:08:18", "starttime" : "2018-03-21T02:24:47-07:00", "endtime" : "2018-03-21T02:33:05-07:00", "usage" : "Archived", "mediastream" : "Flash Audio", "os" : "win8.1", "browser" : "msie11", "streamsource" : "https", "ipaddress" : "115.166.143.238", "exteventusercd" : "986", "launchmode" : "Watching remote" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/calendarreminder" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Email Calendar Reminder", "description" : "Returns information on the email calendar reminder that is configured for a particular event.", "operationId" : "AnalyticsEventLevel.EmailCalendarReminder", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return email calendar reminder details.", "content" : { "application/json" : { "example" : { "eventid" : 11213706, "reminder" : "15 Minutes", "subject" : "Reminder - #EVENTTITLE#", "location" : "Webcast", "body" : "Thank you for registering for #EVENTTITLE#." } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } }, "put" : { "tags" : [ "Event Management" ], "summary" : "Update Email Calendar Reminder", "description" : "Updates the Email Calendar Reminder for a particular event.\n\n- **reminder** parameter conditions:\n - Cannot be updated if the event has already started.\n - Accpeted values:\n - None\n - 0 Minutes\n - 5 Minutes\n - 10 Minutes\n - 15 Minutes\n - 30 Minutes\n - 1 Hour\n - 2 Hours\n - 3 Hours\n - 4 Hours\n - 5 Hours\n - 6 Hours\n - 12 Hours\n - 1 Day", "operationId" : "EventManagement.UpdateEmailCalendarReminder", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/CalendarReminderForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/CalendarReminderForm" } } } }, "responses" : { "200" : { "description" : "Email Calendar Reminder Updated", "content" : { "application/json" : { "example" : { "reminder" : "30 Minutes", "subject" : "Reminder - #EVENTTITLE#", "location" : "Webcast", "body" : "Thank you for registering for #EVENTTITLE#." } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/certifications" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Certifications", "description" : "Returns all certifications for a particular event.", "operationId" : "AnalyticsEventLevel.Certifications", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of certifications for an event", "content" : { "application/json" : { "example" : { "eventId" : 84200656, "certifications" : [ { "certificationid" : 321519436, "certificationname" : "Earn Certification", "certificationcredit" : [ { "type" : "fullcreditoption", "name" : "Criteria for Full Credit", "requiredViewingMinutes" : 10, "requiredNumberOfPollsToAnswer" : 2, "messageForPartialCreditComplete" : "Congratulations, you have completed full credit", "earnedCreditForCompletion" : 100 }, { "type" : "partialcreditoption1", "name" : "Criteria for Partial Credit Option 1", "requiredViewingMinutes" : 5, "requiredNumberOfPollsToAnswer" : 1, "messageForPartialCreditComplete" : "Congratulations, you have completed partial credit", "earnedCreditForCompletion" : 50 } ] } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/contentactivity" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Engagement Hub Content Activity", "description" : "Returns data on the content activity for an Engagement Hub or Target Experience.", "operationId" : "AnalyticsEventLevel.EngagementHubContentActivity", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Returns content activity for the Engagement Hub or Target Experience.\n\n- If **contenttype** is \"Document\" the response will include the field **downloads** indicating the total number of times an item has been downloaded. If **contenttype** is \"Webpage\" the response will Not include **totalviewingduration** and **averageviewingduration**.", "content" : { "application/json" : { "example" : { "eventid" : 2133107, "clientid" : 32120, "description" : "Content Activity Sample", "totalcontentviews" : 12, "contentviewers" : 14, "contents" : [ { "eventid" : 5001932, "clientid" : 32120, "description" : "Content Sample", "contenttype" : "Document", "totalviews" : 4, "uniqueviewers" : 3, "totalviewingduration" : 20, "averageviewingduration" : 15.4, "downloads" : 2, "likes" : 4, "dislikes" : 0, "comments" : 2, "shares" : 1 }, { "eventid" : 5001937, "clientid" : 32120, "description" : "Webpage Sample", "contenttype" : "Webpage", "totalviews" : 5, "uniqueviewers" : 5, "likes" : 2, "dislikes" : 0, "comments" : 3, "shares" : 1 } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "The client id {clientId} is inactive. | The event {eventId} is inactive. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The Engagement Hub or Target Experience {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/cta" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Call To Action", "description" : "Returns information on the CTA (Call to Action) widgets that are configured for a particular event.", "operationId" : "AnalyticsEventLevel.CallToAction", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of CTAs", "content" : { "application/json" : { "example" : { "eventid" : 5465017, "calltoactions" : [ { "ctaid" : 85408052, "ctaname" : "Call To Action 1", "actiontype" : "gateway", "action" : "https://gateway.on24.com/wcc/gateway/Integrationca/1464662?5465017+/Call+To+Action+1/##CONTENTTITLE##", "totalclicks" : 8, "uniqueclicks" : 2 }, { "ctaid" : 85411163, "ctaname" : "Call To Action 2", "actiontype" : "url", "action" : "http://www.on24.com", "totalclicks" : 11, "uniqueclicks" : 3 } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event id {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/email" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Email Notification Details", "description" : "Returns information on the email notifications that are configured for a particular event.", "operationId" : "AnalyticsEventLevel.EmailNotificationDetails", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of emails", "content" : { "application/json" : { "example" : { "eventid" : 11213706, "emails" : [ { "emailid" : 177588, "emailtype" : "Reminder Email #1", "activated" : "Y", "whentosend" : "Custom Date and Time", "goodafter" : "2018-10-31T18:44:59-07:00", "from" : "do_not_reply@on24event.com", "fromlabel" : "Webcast", "replyto" : "do_not_reply@on24event.com", "subject" : "Reminder - #EVENTTITLE#", "body" : "A friendly reminder that #EVENTTITLE# begins in two days." } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event id {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/email/{emailId}" : { "put" : { "tags" : [ "Event Management" ], "summary" : "Update Email Notification", "description" : "Updates an Email Notification for a particular event.\n\n- **fromLabel** validations:\n - Only alphanumeric characters and a maximum of 50 characters are allowed.\n - International characters or email addresses are not allowed.\n- **whentosend** accepted values:\n - 2 Weeks Before Event\n - 1 Week Before Event\n - 5 Days Before Event\n - Days Before Event\n - 2 Days Before Event\n - 1 Day Before Event\n - 12 Hours Before Event\n - 6 Hours Before Event\n - 5 Hours Before Event\n - 4 Hours Before Event\n - 3 Hours Before Event\n - 2 Hours Before Event\n - 1 Hour Before Event\n - 30 Minutes Before Event\n - 15 Minutes Before Event\n - 1 Hour After Event\n - 2 Hours After Event\n - 3 Hours After Event\n - 4 Hours After Event\n - 5 Hours After Event\n - 6 Hours After Event\n - 12 Hours After Event\n - 1 Day After Event\n - 2 Days After Event\n - 3 Days After Event\n - 5 Days After Event\n - 1 Week After Event\n - 2 Weeks After Event\n - When Event Starts\n - Custom Date And Time\n\n## Conditions & Restrictions\nIn order to update an email notification, certain contitions must be met.\n\n- An email can't be updated if already sent.\n\n- 'When to send' Can't be updated if the email type is 'Registration Confirmation Email'.\n\n- If email type is Reminder (#1, #2, #3, #4) , 'When to send' can be set as 'Custom Date and Time' and also 'goodafter' date can be provided.\n\n- Email notification body supporting HTML and Tokens (#FIRSTNAME#, #LASTNAME#, #EMAIL#, #COMPANY#, #EVENTTITLE#, #EVENTDATE#, #EVENTTIME#, #EVENTDAY#, #EVENTTIMEZONESHORT#, #EVENTTIMEZONELONG#, #AUDIENCEURL#, #CALENDARREMINDER#, #EVENTHELPURL#, #DOWNLOADCERTIFICATE#, #EMAILSETTINGSURL#)\n\n- This endpoint provides support for ISO-8601 strings in goodafter parameter. If time information is not provided, it will default to 09:00:00. Following time values are accepted:\n 12:00:00 (12:00 AM), 12:15:00 (12:15 AM), 12:30:00 (12:30 AM), 12:45.00 (12:45 AM),\n 01:00:00 (01:00 AM), 01:15:00 (01:15 AM), 01:30:00 (01:30 AM), 01:45:00 (01:45 AM),\n 02:00:00 (02:00 AM), 02:15:00 (02:15 AM), 02:30:00 (02:30 AM), 02:45:00 (02:45 AM),\n 03:00:00 (03:00 AM), 03:15:00 (03:15 AM), 03:30:00 (03:30 AM), 03:45:00 (03:45 AM),\n 04:00:00 (04:00 AM), 04:15:00 (04:15 AM), 04:30:00 (04:30 AM), 04:45:00 (04:45 AM),\n 05:00:00 (05:00 AM), 05:15:00 (05:15 AM), 05:30:00 (05:30 AM), 05:45:00 (05:45 AM),\n 06:00:00 (06:00 AM), 06:15:00 (06:15 AM), 06:30:00 (06:30 AM), 06:45:00 (06:45 AM),\n 07:00:00 (07:00 AM), 07:15:00 (07:15 AM), 07:30:00 (07:30 AM), 07:45:00 (07:45 AM),\n 08:00:00 (08:00 AM), 08:15:00 (08:15 AM), 08:30:00 (08:30 AM), 08:45:00 (08:45 AM),\n 09:00:00 (09:00 AM), 09:15:00 (09:15 AM), 09:30:00 (09:30 AM), 09:45:00 (09:45 AM),\n 10:00:00 (10:00 AM), 10:15:00 (10:15 AM), 10:30:00 (10:30 AM), 10:45:00 (10:45 AM),\n 11:00:00 (11:00 AM), 11:15:00 (11:15 AM), 11:30:00 (11:30 AM), 11:45:00 (11:45 AM),\n 12:00:00 (12:00 PM), 12:15:00 (12:15 PM), 12:30:00 (12:30 PM), 12:45:00 (12:45 PM),\n 13:00:00 (01:00 PM), 13:15:00 (01:15 PM), 13:30:00 (13:30 PM), 13:45:00 (01:45 PM),\n 14:00:00 (02:00 PM), 14:15:00 (02:15 PM), 14:30:00 (02:30 PM), 14:45:00 (02:45 PM),\n 15:00:00 (03:00 PM), 15:15:00 (03:15 PM), 15:30:00 (03:30 PM), 15:45:00 (03:45 PM),\n 16:00:00 (04:00 PM), 16:15:00 (04:15 PM), 16:30:00 (04:30 PM), 16:45:00 (04:45 PM), \n 17:00:00 (05:00 PM), 17:15:00 (05:15 PM), 17:30:00 (05:30 PM), 17:45:00 (05:45 PM),\n 18:00:00 (06:00 PM), 18:15:00 (06:15 PM), 18:30:00 (06:30 PM), 18:45:00 (06:45 PM),\n 19:00:00 (07:00 PM), 19:15:00 (07:15 PM), 19:30:00 (07:30 PM), 19:45:00 (07:45 PM),\n 20:00:00 (08:00 PM), 20:15:00 (08:15 PM), 20:30:00 (08:30 PM), 20:45:00 (08:45 PM),\n 21:00:00 (09:00 PM), 21:15:00 (09:15 PM), 21:30:00 (09:30 PM), 21:45:00 (09:45 PM),\n 22:00:00 (10:00 PM), 22:15:00 (10:15 PM), 22:30:00 (10:30 PM), 22:45:00 (10:45 PM),\n 23:00:00 (11:00 PM), 23:15:00 (11:15 PM), 23:30:00 (11:30 PM), 23:45:00 (11:45 PM)\n\n- If email type is Reminder (#1, #2, #3, #4) email, following values are accepted for 'when to send':\n - 2 Weeks Before Webcast, 1 Week Before Webcast,\n - 5 Days Before Webcast, 3 Days Before Webcast, 2 Days Before Webcast, 1 Day Before Webcast,\n - 12 Hours Before Webcast, 6 Hours Before Webcast, 5 Hours Before Webcast, \n - 4 Hours Before Webcast, 3 Hours Before Webcast, 2 Hours Before Webcast, 1 Hour Before Webcast,\n - 30 Minutes Before Webcast, 15 Minutes Before Webcast,\n - When Webcast Starts,\n - Custom Date And Time\n\n- If email type is \"Sorry We Missed You\" or \"Thank You for Attending\" Email, following values are accepted for 'when to send':\n - 1 Hour After Webcast, 2 Hours After Webcast, 3 Hours After Webcast,\n - 4 Hours After Webcast, 5 Hours After Webcast, 6 Hours After Webcast, 12 Hours After Webcast,\n - 1 Day After Webcast, 2 Days After Webcast, 3 Days After Webcast, 5 Days After Webcast,\n - 1 Week After Webcast, 2 Weeks After Webcast", "operationId" : "EventManagement.UpdateEmailNotification", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "emailId", "in" : "path", "description" : "The email id", "required" : true, "schema" : { "type" : "string" }, "example" : 7055969 }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/UpdateEmailNotificationForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/UpdateEmailNotificationForm" } } } }, "responses" : { "200" : { "description" : "Email Notification Updated", "content" : { "application/json" : { "example" : { "emailid" : 177588, "emailtype" : "Reminder Email #1", "activated" : "Y", "whentosend" : "Custom Date and Time", "goodafter" : "2018-10-31T18:44:59-07:00", "from" : "do_not_reply@on24event.com", "fromlabel" : "Webcast", "replyto" : "do_not_reply@on24event.com", "subject" : "Reminder - #EVENTTITLE#", "body" : "A friendly reminder that #EVENTTITLE# begins in two days." } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event id {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist. | The email {emailId} doesn't exist" } } } }, "/client/{clientId}/event/{eventId}/emailstatistics" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Email Statistics", "description" : "Returns all email statistics for a particular event.", "operationId" : "AnalyticsEventLevel.EmailStatistics", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of email statistics for an event", "content" : { "application/json" : { "example" : { "eventId" : 84200656, "emailStatistics" : [ { "email" : "Reminder Email #2", "subject" : "Reminder - 2", "sent" : 4, "opened" : 1, "openrate" : 0.25, "delivered" : 2, "deliveryrate" : 0.5, "clicked" : 2, "clickedthroughrate" : 0.5, "clicktoopenrate" : 2.0 } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/forgetall" : { "post" : { "tags" : [ "REST Registration" ], "summary" : "Forget All Registrant (event-level)", "description" : "Forgets personal data for all registrant records in the specified event.\n\nThe following registrant fields are modified by this endpoint:\n\n- email = {event_user_id}-deleted\n- firstname = 'deleted'\n- lastname = 'deleted'\n- last_update = {Current date time}\n- last_update_by = adminid\n- company = NULL\n- address_street1 = NULL\n- address_street2 = NULL\n- city = NULL\n- state = NULL\n- event_user_ip = NULL\n- operating_system = NULL\n- browser = NULL\n- zip = NULL\n- home_phone = NULL\n- work_phone = NULL\n- fax = NULL\n- company_industry = NULL\n- username = NULL\n- job_function = NULL\n- company_size = NULL\n- ipnumber = NULL\n- longitude = NULL\n- latitude = NULL\n- job_title = NULL\n- std1 = NULL\n- std2 = NULL\n- std3 = NULL\n- std4 = NULL\n- std5 = NULL\n- std6 = NULL\n- std7 = NULL\n- std8 = NULL\n- std9 = NULL\n- std10 = NULL\n- country = NULL\n- event_email = 'N'\n- marketing_email = 'N'", "operationId" : "Registration.ForgetAllRegistrantEventlevel", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "Application/json" }, { "name" : "content-type", "in" : "header", "description" : "Possible values: \"application/x-www-form-urlencoded\" or \"multipart/formdata\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Registrant Forgotten.", "content" : { "application/json" : { "example" : { "deletedregistrants" : { "eventuserids" : [ 150070598, 150070556 ] } } } } }, "400" : { "description" : "You have exceeded the maximum number of user to be deleted (100,000)" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The event XXXXXX doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/groupchat" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Group Chat Activity", "description" : "Returns information on the group chat activity data for a particular event.", "operationId" : "AnalyticsEventLevel.GroupChatActivity", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return group chat details.", "content" : { "application/json" : { "example" : { "eventid" : 11213706, "groupchats" : [ { "groupchatid" : 86603081, "groupchatname" : "Group Chat 1", "uniqueviews" : 1, "totalviews" : 1, "chatmessages" : [ { "createtimestamp" : "2019-08-26T12:35:10-07:00", "eventuserid" : 224152601, "email" : "xxxxxxxxx@on24.com", "firstname" : "Alejandro", "lastname" : "xxxxxx", "chatmessage" : "This is chat message from attendee" }, { "createtimestamp" : "2019-08-26T12:38:29-07:00", "presenterid" : 2977455, "email" : "xxxxxxxxxx@on24.com", "firstname" : "Rick", "lastname" : "xxxxxxx", "chatmessage" : "This is chat message from presenter" } ] } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event id {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/poll" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Polls", "description" : "Returns polls for a particular event. All dates and times are in Pacific Time.", "operationId" : "AnalyticsEventLevel.Polls", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of polls for an event", "content" : { "application/json" : { "example" : { "eventid" : 311512, "polls" : [ { "pollid" : 16818630, "polltype" : "singleoption", "pollquestionid" : 6268358, "pollquestion" : "How familiar are you with virtual event solutions?", "totalvotes" : 67, "livepushedtimestamp" : "2023-05-19T06:14:17-07:00", "summary" : [ { "answercode" : "choice1", "answer" : "Very Familiar", "percentage" : 7.5 }, { "answercode" : "choice2", "answer" : "Somewhat Familiar", "percentage" : 62.7 }, { "answercode" : "choice3", "answer" : "Unfamiliar", "percentage" : 22.4 }, { "answercode" : "choice4", "answer" : "Not Sure", "percentage" : 7.4 } ] }, { "pollid" : 16818601, "polltype" : "multioption", "pollquestionid" : 6268336, "pollquestion" : "Which products are you interested in? (select all that apply)", "totalvotes" : 43, "livepushedtimestamp" : "2023-05-19T06:28:12-07:00", "summary" : [ { "answercode" : "choice1", "answer" : "Self Service Webcasts", "percentage" : 25.6 }, { "answercode" : "choice2", "answer" : "Full Service Webcasts", "percentage" : 44.2 }, { "answercode" : "choice3", "answer" : "Virtual Business Centers", "percentage" : 30.2 } ] } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/presenter" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Presenters", "description" : "Returns a listing of presenters for a particular event.", "operationId" : "AnalyticsEventLevel.Presenters", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of presenters", "content" : { "application/json" : { "example" : { "eventpresenters" : [ { "presenterid" : 2009445, "firstname" : "sumiti", "lastname" : "XXXXX", "email" : "xxxxxxxxxx@on24.com", "accessmode" : "Producer", "starttime" : "2017-07-26T01:50:53-07:00", "endtime" : "2017-07-26T03:34:22-07:00", "ispracticesession" : "N" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "The client id {clientId} is inactive. | You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist" } } } }, "/client/{clientId}/event/{eventId}/presenterchat" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Presentation Manager Chat Logs", "description" : "Returns Presentation Manager chat logs for a webinar.", "operationId" : "AnalyticsEventLevel.PresentationManagerChatLogs", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return information for an event.", "content" : { "application/json" : { "example" : { "eventid" : 11213706, "presenterchats" : [ { "presenterid" : 2009445, "firstname" : "sumiti", "lastname" : "XXXXX", "email" : "xxxxxxxxxx@on24.com", "accessmode" : "Producer", "chatid" : 62689, "createtimestamp" : "2022-01-26T01:50:53-07:00", "content" : "Hello , this is an internal chat message" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | The client id {clientId} is inactive. | You have reached the maximum number of calls for this api. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/regfield" : { "get" : { "tags" : [ "Helpers" ], "summary" : "Retrieve Registration Fields", "description" : "Retrieves registration field information for a particular event", "operationId" : "Helpers.RetrieveRegistrationFields", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b21600" }, { "name" : "accept", "in" : "header", "description" : "Output format: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "example" : { "registrationfields" : [ { "fieldid" : "firstname", "fieldcaption" : "First Name", "fieldtype" : "textbox", "validationtype" : "none", "required" : "Y" }, { "fieldid" : "lastname", "fieldcaption" : "Last Name", "fieldtype" : "textbox", "validationtype" : "none", "required" : "Y" }, { "fieldid" : "email", "fieldcaption" : "Email", "fieldtype" : "textbox", "validationtype" : "email", "required" : "Y" }, { "fieldid" : "company", "fieldcaption" : "Company", "fieldtype" : "textbox", "validationtype" : "none", "required" : "Y" }, { "fieldid" : "job_title", "fieldcaption" : "Title", "fieldtype" : "listbox", "validationtype" : "none", "required" : "Y", "options" : [ "Manager", "Senior Manager", "Director", "Senior Director", "CMO", "CFO", "CEO", "CTO" ] } ] } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "The client id is not an Elite user/The adminId can not perform operations under client clientId; or You reached the maximum number of calls for this endpoint" }, "404" : { "description" : "The event id is not found under this client account" } } } }, "/client/{clientId}/event/{eventId}/registrant" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Registrants", "description" : "Retrieves a list of registrants for a particular event.\n\n- If double opt-in verification was enabled at the time of registration for an event and a user has not completed the verification process, the user will not be included in any endpoint responses.\n- **dateFilterMode** parameter options (not case-sensitive):\n - If the parameter is not included or no value is supplied, **startDate** and **endDate** will work in the manner they usually do.\n - \"lastActivity\" is the only supported value. When passed, the response will include only those registrants who have had activity between (and including) the provided startDate and endDate. Registrant lastActivity value is updated with a new modified date whenever one of the following API endpoints gets invoked to modify the registration information:\n - REST Registration\n - Update Registrant (client-level)\n - Forget Registrant (client-level)\n - Forget All Registrant (client-level)\n - Forget All Registrant (event-level)", "operationId" : "AnalyticsEventLevel.Registrants", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "dateInterval", "in" : "query", "description" : "Number of days returned in a response. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64" }, "example" : 30 }, { "name" : "dateIntervalOffset", "in" : "query", "description" : "Number of days from which the interval should encompass. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 4 }, { "name" : "dateIntervalTimezone", "in" : "query", "description" : "Timezone to be used for determining the 24 hour period that constitutes a day. See Rolling Interval.", "schema" : { "type" : "string", "default" : "America/Los_Angeles" }, "example" : "America/Los_Angeles" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" }, { "name" : "startdate", "in" : "query", "description" : "Limit results to registrants with registration date after startDate", "schema" : { "type" : "string" }, "example" : "2017-12-31" }, { "name" : "enddate", "in" : "query", "description" : "Limit results to registrants with registration date before endDate", "schema" : { "type" : "string" }, "example" : "2017-12-31" }, { "name" : "partnerref", "in" : "query", "description" : "Filter by partnerref", "schema" : { "type" : "string" }, "example" : "EM" }, { "name" : "userstatus", "in" : "query", "description" : "Filter to users based on their status. If not provided, only regular users will be returned. Possible values: any: will return all registrants, including: active, soft-deleted and forgotten registrants. deleted: will return soft-deleted users only. forgotten: will return forgotten users only. all: **deprecated** - will include regular and soft-deleted users. **Note:** By design, there is No option to exclude soft-deleted users from the response.", "schema" : { "type" : "string", "default" : "any" }, "example" : "any" }, { "name" : "email", "in" : "query", "description" : "email registrant filter", "schema" : { "type" : "string" }, "example" : "test@domain.com" }, { "name" : "noshow", "in" : "query", "description" : "Filters registrants who did not show up for the event", "schema" : { "type" : "string", "default" : "N" }, "example" : "Y" }, { "name" : "filterforgotten", "in" : "query", "description" : "**Deprecated** - Forgotten registrants filter. Y: only forgotten users will be returned in the response. N: forgotten users will be omitted in the response.", "schema" : { "type" : "string", "default" : "N" }, "example" : "Y" }, { "name" : "excludeanonymous", "in" : "query", "description" : "**Deprecated** - System-Generated (anonymous) email addresses are now always excluded from responses. This parameter is retained for backward compatibility but no longer affects the result set.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "Y" }, { "name" : "datefiltermode", "in" : "query", "description" : "Type of date to be used with the startDate and endDate parameters.", "schema" : { "type" : "string" }, "example" : "lastActivity" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of registrants for an event\n\n- This endpoint returns data on people who registered for a Virtual Environment (VE).\n- Properties that will not be returned for VE registrants include:\n - userprofileurl\n - engagementprediction\n - emailformat\n- The following values are cached on the server between 3 - 24 hours:\n - engagementprediction", "content" : { "application/json" : { "example" : { "eventid" : 311512, "totalregistrants" : 1, "registrants" : [ { "eventuserid" : 49177588, "firstname" : "Gina", "lastname" : "Xxxxxx", "email" : "xxxxxxxxx@on24.com", "company" : "ON24", "jobtitle" : "marketing", "addressstreet1" : "XXXXX XX XXX", "addressstreet2" : "XXX-XX", "city" : "Mountainview", "state" : "CA", "zip" : "02139", "country" : "United States", "workphone" : "(123)-456-7890", "jobfunction" : "Manager", "companyindustry" : "Software", "companysize" : "1 - 49", "partnerref" : "Ref1", "eventid" : 311512, "std1" : "std1", "std2" : "std2", "std3" : "std3", "std4" : "std4", "std5" : "std5", "std6" : "std6", "std7" : "std7", "std8" : "std8", "std9" : "std9", "std10" : "std10", "fax" : "(123)-456-7890", "username" : "glockhart", "exteventusercd" : "154092645", "other" : "sample field content", "notes" : "sample note 1", "marketingemail" : "N", "eventemail" : "Y", "homephone" : "(123)-456-7890", "createtimestamp" : "2017-05-08T18:44:59-07:00", "lastactivity" : "2017-05-08T18:44:59-07:00", "browser" : "mozilla/5.0", "ipaddress" : "80.115.1.5", "os" : "win10", "emailformat" : "text", "engagementprediction" : "LOW", "userprofileurl" : "https://data.on24.com/webcast/lead?token=EZB3pmHf6Pa-74Pu8sHetFxWDF64bdJ6VhSTJo42qfacGzyB0gEyQCFjUSHJ74ZzETfjZizOdUBFm3JYSG-lyGiPb8_sDbY1RbbdlMtLndM=", "campaigncode" : "CMP-001", "sourcecampaigncode" : "CMP-001", "sourceeventid" : 2141380, "userstatus" : "active", "utmsource" : "newsletter", "utmmedium" : "banner", "utmcampaign" : "spring_sale_2022", "utmterm" : "spring+sale", "utmcontent" : "https://mydomain.com/i/p/campaigns/spring_sale_2022.jpg", "attendeetype" : "Virtual" } ] } } } }, "400" : { "description" : "Invalid Date format for params startdate and enddate. Incorrect timezone value provided." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | The client id {clientId} is inactive. | You have reached the maximum number of calls for this api. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } }, "post" : { "tags" : [ "REST Registration" ], "summary" : "REST Registration API", "description" : "Creates a registrant.\n\n### Soft Delete\n\nPerform a soft delete operation on a particular Registrant by sending the 'isDeleted' form parameter with the value of (Y or N) to update the deleted state of such Registrant. This value can be sent along with the other form parameters listed in the table above. Deleting/Undeleting a registrant is not allowed after the event has started.\n\n| Name | Located In | Required | Description | Default | Schema | Example |\n| --- | --- | --- | --- | --- | --- | --- |\n| **isDeleted** | formData | yes | Performs an update on the isDeleted property of a Registrant | - | string | Y |\n| **email** | formData | yes | The email of the registrant who will be updated | - | string | john.doe@domain.com |\n\n### Validation\n\n- If a field is configured as \"required\" on the registration page, you must pass in a valid value, or the request will not be successful unless you are using the **honorrequired** as \"N\" parameter.\n- The **honorrequired** parameter is supported with possible values of Y or N. If Y is passed (or no value or no parameter is passed), the endpoint will behave as it currently does. If N is passed:\n - Fields configured as required will be optional (including email)\n - If a drop-down field is passed, the value must adhere to configured options unless you are using the **honorvalidation** as \"N\".", "operationId" : "Registration.RESTRegistrationAPI", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "must be \"application/x-www-form-urlencoded\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "honorrequired", "in" : "query", "description" : "Specifies whether the required registration fields must be honored or not.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "N" }, { "name" : "honorvalidation", "in" : "query", "description" : "Specifies whether validation of response options for registration questions must be honored. Using 'N' allows any value to be pushed to fields with specified values for dropdown list, checkboxes, etc.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "N" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "Application/json" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/AddRegistrantForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/AddRegistrantForm" } } } }, "responses" : { "200" : { "description" : "Registrant Created.", "content" : { "application/json" : { "example" : { "firstname" : "Daniel", "lastname" : "xxxxxx", "email" : "xxxxx.xxxxxx@on24.com", "company" : "ON24", "jobtitle" : "JT", "addressstreet1" : "AS1", "addressstreet2" : "AS2", "city" : "CT", "state" : "ST", "zip" : "ZP", "country" : "CO", "homephone" : "(123)-456-7890", "workphone" : "765-4321", "fax" : "456-7891", "jobfunction" : "JF", "companyindustry" : "CI", "companysize" : "1", "partnerref" : "PR", "eventid" : 2008859, "eventuserid" : 150148905, "std1" : "std1", "std2" : "std2", "std3" : "std3", "std4" : "std4", "std5" : "std5", "std6" : "std6", "std7" : "std7", "std8" : "std8", "std9" : "std9", "std10" : "std10", "username" : "UN", "exteventusercd" : "ABC123", "other" : "OT", "notes" : "N", "marketingemail" : "N", "eventemail" : "Y", "isblocked" : "Y", "userprofileurl" : "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5brm4beGxsvO3kUs1quJjdRgI2I6yPbVNW_mPrtwI62lB8x9yCrFDiB0SZlYWFuYn7jmEnqWo6KlT73VwKn3wS2ggIe4=", "emailformat" : "html" } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid. | AccessTokenKey and AccessTokenSecret are deactivated." }, "403" : { "description" : "The client id {clientId} is inactive. | The event id {eventId} is inactive. | You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." }, "412" : { "description" : "You're trying to soft delete the registrant you're creating." } } }, "patch" : { "tags" : [ "REST Registration" ], "summary" : "Update Registrant (event-level)", "description" : "Updates an event registrant for the given client using the PATCH method. This means that only those registration fields that are part of the request will be updated.\n\nThe registrant to be updated will be identified by the provided email parameter value.\n\n### Soft Delete\n\nSoft delete is not supported through this endpoint. If you need to perform a soft delete on a registrant, please refer to REST Registration.\n\n### Validation\n\n- An optional 'honorrequired' parameter is supported with possible values of Y or N. If Y is passed (or no value or no parameter is passed), the endpoint will behave as it currently does. If N is passed:\n\n\t1. Fields configured as required will be optional (including email)\n\t2. If a drop-down field is passed, the value must adhere to configured options\n\n- If any of the fields have been marked as required on the Registration Page Setup, then those fields will be required in the API as well.\n- Drop-down choices will be validated (if the value passed does not exist in the drop-down, an error will be returned.)\n- If a required field is missing or passed in without a value, then an error message will be returned.", "operationId" : "Registration.UpdateRegistrantEventlevel", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "must be \"application/x-www-form-urlencoded\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "honorrequired", "in" : "query", "description" : "Specifies whether the required registration fields must be honored or not.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "N" }, { "name" : "honorvalidation", "in" : "query", "description" : "Specifies whether validation of response options for registration questions must be honored. Using 'N' allows any value to be pushed to fields with specified values for dropdown list, checkboxes, etc.", "schema" : { "type" : "string", "default" : "Y" }, "example" : "N" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "Application/json" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/UpdateRegistrantForm" } } } }, "responses" : { "200" : { "description" : "Registrant updated.", "content" : { "application/json" : { "example" : { "firstname" : "Daniel", "lastname" : "xxxxxx", "email" : "xxxxx.xxxxxx@on24.com", "company" : "ON24", "jobtitle" : "JT", "addressstreet1" : "AS1", "addressstreet2" : "AS2", "city" : "CT", "state" : "ST", "zip" : "ZP", "country" : "CO", "homephone" : "(123)-456-7890", "workphone" : "765-4321", "fax" : "456-7891", "jobfunction" : "JF", "companyindustry" : "CI", "companysize" : "1", "partnerref" : "PR", "eventid" : 2008859, "eventuserid" : 150148905, "std1" : "std1", "std2" : "std2", "std3" : "std3", "std4" : "std4", "std5" : "std5", "std6" : "std6", "std7" : "std7", "std8" : "std8", "std9" : "std9", "std10" : "std10", "username" : "UN", "exteventusercd" : "ABC123", "other" : "OT", "notes" : "N", "marketingemail" : "N", "eventemail" : "Y", "isblocked" : "Y", "userprofileurl" : "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5brm4beGxsvO3kUs1quJjdRgI2I6yPbVNW_mPrtwI62lB8x9yCrFDiB0SZlYWFuYn7jmEnqWo6KlT73VwKn3wS2ggIe4=", "emailformat" : "html" } } } }, "400" : { "description" : "The email parameter is missing. | The email parameter value is blank. | Invalid value for the honorrequired parameter. | Invalid value for the honorvalidation parameter. | Invalid value for the inBlocked parameter." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid. | AccessTokenKey and AccessTokenSecret are deactivated." }, "403" : { "description" : "The client id {clientId} is inactive. | The event id {eventId} is inactive. | The email provided was not found. | You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/relatedcontent" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Create Related Content", "description" : "This endpoint will upload files and links to a Webinar's Related Content widget.\n\n### Supported File Types\n\n- .doc\n- .docx\n- .xls\n- .xlsx\n- .pdf\n- .ppt\n- .pptx\n- .mp3\n- .mp4\n\n### File Max Size\n\n- 50 MB", "operationId" : "EventManagement.CreateRelatedContent", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "Content-Type", "in" : "header", "description" : "Must be \"multipart/form-data\".", "required" : true, "schema" : { "type" : "string" }, "example" : "multipart/form-data" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/CreateRelatedContentForm" } } } }, "responses" : { "200" : { "description" : "Content processed", "content" : { "application/json" : { "examples" : { "type: Resource" : { "description" : "type: Resource", "value" : { "message" : "RECEIVED", "resource" : { "name" : "ON24 Whitepaper", "file" : "myfile.pdf" } } }, "type: URL" : { "description" : "type: URL", "value" : { "message" : "RECEIVED", "resource" : { "name" : "ON24 Website", "url" : "https://www.on24.com" } } } } } } }, "400" : { "description" : "File is not accepted filetype | More than one {matchname} for event {eventid}" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid | You do not have permission to perform the requested operation" }, "403" : { "description" : "You have reached the maximum number of calls for this api | The client id {clientId} is inactive | The event id {eventId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist | The event {eventId} doesn't exist | {matchname} not found for event {eventid}" } } } }, "/client/{clientId}/event/{eventId}/resource" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Resources Viewed", "description" : "Returns resources for a particular event. All dates and times are in Pacific Time.", "operationId" : "AnalyticsEventLevel.ResourcesViewed", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of resources viewed for an event", "content" : { "application/json" : { "example" : { "totalresources" : 2, "resourcesviewed" : [ { "resourceid" : 183212518, "resourcename" : "5 keys to webcasting", "uniquedownloads" : 4, "totaldownloads" : 7 }, { "resourceid" : 183211829, "resourcename" : "Frost and Sullivan 2012", "uniquedownloads" : 4, "totaldownloads" : 5 } ], "resourcesnotviewed" : [ { "resourceid" : 183212528, "resourcename" : "7 keys to webcasting" } ] } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/slides" : { "get" : { "tags" : [ "Event Management" ], "summary" : "Slide Listing", "description" : "Returns information about event slides.", "operationId" : "EventManagement.SlideListing", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Returns a list of slides", "content" : { "application/json" : { "example" : { "eventid" : 1111111, "eventtitle" : "My Webcast", "slides" : [ { "mediaurlid" : 144085980, "message" : "SUCCESS", "mediafile" : "myPresentation.pptx" }, { "mediaurlid" : 144085981, "message" : "SUCCESS", "mediafile" : "myPresentation2.pptx" } ] } } } }, "400" : { "description" : "Invalid filetype." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid" }, "403" : { "description" : "You do not have permission to perform the requested operation | You have reached the maximum number of calls for this api | The client id {clientId} is inactive | The client id {eventId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist | The client {eventId} doesn't exist | No slides found" } } }, "post" : { "tags" : [ "Event Management" ], "summary" : "Upload Slides", "description" : "Uploads slides to a webinar.", "operationId" : "EventManagement.UploadSlides", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/UploadSlidesForm" } } } }, "responses" : { "200" : { "description" : "File queued to be processed", "content" : { "application/json" : { "example" : { "message" : "RECEIVED", "mediafile" : "myPresentation.pptx" } } } }, "400" : { "description" : "File is not a Power Point presentation" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid" }, "403" : { "description" : "You do not have permission to perform the requested operation | You have reached the maximum number of calls for this api | The client id {clientId} is inactive | The client id {eventId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist | The client {eventId} doesn't exist" } } } }, "/client/{clientId}/event/{eventId}/speakerbio" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Create Speaker Bio", "description" : "Creates a new speaker bio element in the Speaker Bio widget of a webinar.\n\n- A Speaker Bio widget must already exist in the webinar. If a Speaker Bio widget does not exist, a 404 response will be returned.\n\n### Supported File Types for Speaker Bio Image\n\n- .jpg\n- .gif\n- .png\n\n### Required 'metadata' JSON key-value pairs\n\n- name\n- email\n\n### 'metadata' restrictions\n\n- Only up to three (3) among \"email\", \"twitter\", \"linkedin\", \"website\", and \"facebook\" can be provided. Providing more than three will result in a 400 *Invalid metadata* response.", "operationId" : "EventManagement.CreateSpeakerBio", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "It must be: \"multipart/form-data\"", "required" : true, "schema" : { "type" : "string" }, "example" : "multipart/form-data" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/CreateSpeakerBioForm" } } } }, "responses" : { "200" : { "description" : "Speaker Bio created.", "content" : { "application/json" : { "example" : { "message" : "RECEIVED", "speaker" : { "id" : 123, "file" : "myfile.jpg", "name" : "John Doe", "title" : "Product Manager", "company" : "ON24", "email" : "john.doe@on24.com", "linkedin" : "https://x", "website" : "https://x", "description" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." } } } } }, "400" : { "description" : "Invalid metadata or file is not accepted filetype." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist. | The Speaker Bio widget is not available for this event." } } }, "delete" : { "tags" : [ "Event Management" ], "summary" : "Delete Speaker Bio", "description" : "Deletes all speaker bio data for specific event webinar.", "operationId" : "EventManagement.DeleteSpeakerBio", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Speaker bio data Deleted.", "content" : { "application/json" : { "example" : { "message" : "Speaker bio data has been deleted." } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "You don't have access to this client id; or You don't have ability to delete this speaker bio; or You reached the maximum number of calls for this endpoint" }, "404" : { "description" : "Event not found for this client or its children" } } } }, "/client/{clientId}/event/{eventId}/survey" : { "get" : { "tags" : [ "Event Level Analytics" ], "summary" : "Surveys", "description" : "Returns surveys for a particular event. All dates and times are in Pacific Time.", "operationId" : "AnalyticsEventLevel.Surveys", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "description" : "Return list of surveys for an event", "content" : { "application/json" : { "examples" : { "Elite account" : { "description" : "Elite account", "value" : { "eventid" : 311512, "surveys" : [ { "surveyid" : "311512_survey1", "surveycode" : "survey1", "surveyquestions" : [ { "questionid" : 8887738, "questiontype" : "singleoption", "question" : "What is your age?", "questioncode" : 110, "responses" : 0 }, { "questionid" : 6268271, "questiontype" : "singleoption", "question" : "What industry are you in?", "questioncode" : 210, "responses" : 74, "surveyanswer" : [ { "answercode" : "choice1", "answer" : "Technology", "percentage" : 16.3 }, { "answercode" : "choice2", "answer" : "HealthCare", "percentage" : 6.8 }, { "answercode" : "choice3", "answer" : "Finance", "percentage" : 36.4 }, { "answercode" : "choice4", "answer" : "Retail", "percentage" : 27 }, { "answercode" : "choice5", "answer" : "Food & Beverage", "percentage" : 13.5 } ] }, { "questionid" : 6268299, "questiontype" : "singletext", "question" : "Which tools are you using today?", "questioncode" : 315, "responses" : 8 }, { "questionid" : 6268293, "questiontype" : "singleoption", "question" : "How valuable was the information presented?", "questioncode" : 673, "responses" : 74, "surveyanswer" : [ { "answercode" : "choice1", "answer" : "Very valuable", "percentage" : 50.1 }, { "answercode" : "choice2", "answer" : "Valuable", "percentage" : 28.4 }, { "answercode" : "choice3", "answer" : "Neutral", "percentage" : 8.1 }, { "answercode" : "choice4", "answer" : "Somewhat Valuable", "percentage" : 6.7 }, { "answercode" : "choice5", "answer" : "Not Valuable at all", "percentage" : 6.7 } ] }, { "questionid" : 6268306, "questiontype" : "singleoption", "question" : "Would you like a 1:1 session with an expert?", "questioncode" : 704, "responses" : 74, "surveyanswer" : [ { "answercode" : "choice1", "answer" : "Yes", "percentage" : 12.2 }, { "answercode" : "choice2", "answer" : "No", "percentage" : 87.8 } ] } ] } ] } }, "VE account" : { "description" : "VE account", "value" : { "eventid" : 6419578, "surveys" : [ { "surveyid" : "804031", "surveycode" : "Survey1", "surveyquestions" : [ { "questionid" : 3188046, "questiontype" : "singletext", "question" : "free response 1", "responses" : 1 }, { "questionid" : 3188047, "questiontype" : "multioption", "question" : "Multiple Answer 1", "responses" : 1, "surveyanswer" : [ { "answercode" : "259739", "answer" : "Answer 1", "percentage" : 100.0 }, { "answercode" : "259740", "answer" : "Answer 2", "percentage" : 100.0 }, { "answercode" : "259741", "answer" : "Answer 3", "percentage" : 0.0 } ] }, { "questionid" : 3188048, "questiontype" : "singleoption", "question" : "Single Answer 1", "responses" : 1, "surveyanswer" : [ { "answercode" : "259743", "answer" : "one", "percentage" : 100.0 }, { "answercode" : "259744", "answer" : "two", "percentage" : 0.0 }, { "answercode" : "259745", "answer" : "three", "percentage" : 0.0 } ] } ] } ] } } } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The event {eventId} doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/surveyquestions" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Create Survey Questions and Answers", "description" : "Creates one or several survey questions and their answers for a particular webinar.\n\n- A Take Survey widget must already exist in the webinar. If a Take Survey widget does not exist, a 404 response will be returned.", "operationId" : "EventManagement.CreateSurveyQuestionsAndAnswers", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "It must be either \"application/x-www-form-urlencoded\" or \"application/json\" depending on the preferred way to send the metadata object: as a formData parameter or as the request body using Content-Type = \"application/json\".", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/CreateSurveyQuestionForm" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSurveyQuestionForm" } } } }, "responses" : { "200" : { "description" : "Questions created.", "content" : { "application/json" : { "example" : { "eventid" : 82529344, "surveyquestions" : [ { "questiontype" : "multioption", "required" : "Y", "question" : "What industry are you in?", "surveyanswers" : [ { "answercode" : "choice1", "answer" : "Technology" }, { "answercode" : "choice2", "answer" : "HealthCare" }, { "answercode" : "choice3", "answer" : "Finance" }, { "answercode" : "choice4", "answer" : "Retail" }, { "answercode" : "choice5", "answer" : "Food & Beverage" } ] }, { "questiontype" : "singleoption", "required" : "N", "question" : "Would you like a 1:1 session with an expert?", "surveyanswers" : [ { "answercode" : "choice1", "answer" : "Yes" }, { "answercode" : "choice2", "answer" : "No" } ] }, { "questiontype" : "singletext", "required" : "N", "question" : "Describe yourself", "surveyanswers" : [ { "answercode" : "choice1", "answer" : "" } ] } ] } } } }, "400" : { "description" : "Invalid metadata." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid. | You do not have permission to perform the requested operation." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist. | The Take Survey widget is not available for this event." } } } }, "/client/{clientId}/event/{eventId}/textwithbanner" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Update Text With Banner Widget", "description" : "Updates the text content of a webinar's Text With Banner widget.\n\n- At least one Text With Banner widget must already exist in the webinar. If a Text With Banner widget does not exist, a 404 response will be returned.\n- The \"matchname\" metadata field value must be the same as the Text With Banner widget name. If a Text With Banner widget does not exist with the \"matchname\" value, a 404 response will be returned.\n- After successfully executing this endpoint, the previously existing text content of the widget will be overwritten.\n- **type** parameter options:\n - \"text\" is intended for plain text content.\n - \"table\" is intended for tabular information. All rows must have the same number of columns and these must be called column1 to columnN, otherwise a 400 response will be returned.", "operationId" : "EventManagement.UpdateTextWithBannerWidget", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "content-type", "in" : "header", "description" : "It must be: \"application/x-www-form-urlencoded\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/UpdateTextWithBannerForm" } } } }, "responses" : { "200" : { "description" : "Widget text content updated.", "content" : { "application/json" : { "examples" : { "type: \"text\"" : { "description" : "type: \"text\"", "value" : { "message" : "RECEIVED", "content" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." } }, "type: \"table\"" : { "description" : "type: \"table\"", "value" : { "message" : "RECEIVED", "content" : [ { "column1" : "Speaker Name", "column2" : "Speaker Place of Work", "column3" : "Timing of session", "column4" : "Name of session" }, { "column1" : "Jared Chappin", "column2" : "ON24", "column3" : "12:00 PM - 12:30 PM", "column4" : "This is my session name" }, { "column1" : "Mason Chappin", "column2" : "ON24", "column3" : "12:30 PM - 1:00 PM", "column4" : "This is another session" } ] } } } } } }, "400" : { "description" : "Invalid metadata." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid. | You do not have permission to perform the requested operation." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive. | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist. | The event {eventId} doesn't exist. | The Text With Banner widget doesn't exist." } } } }, "/client/{clientId}/event/{eventId}/vtt" : { "delete" : { "tags" : [ "Event Management" ], "summary" : "Delete VTT Files", "description" : "Deletes all vtt files for specific event webinar.", "operationId" : "EventManagement.DeleteVTTFiles", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "number" }, "example" : 1498 }, { "name" : "eventId", "in" : "path", "description" : "The event id", "required" : true, "schema" : { "type" : "number" }, "example" : 1487542 } ], "responses" : { "200" : { "content" : { "application/json" : { "example" : { "message" : "VTT files have been deleted." } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid | You do not have permission to perform the requested operation" }, "403" : { "description" : "You have reached the maximum number of calls for this api | The client id {clientId} is inactive | The event {eventId} is inactive." }, "404" : { "description" : "The client {clientId} doesn't exist | The event {eventId} doesn't exist." } } } }, "/client/{clientId}/eventmanager" : { "get" : { "tags" : [ "Helpers" ], "summary" : "Retrieve Event Managers", "description" : "Retrieves Event Manager Contacts.", "operationId" : "Helpers.RetrieveEventManagers", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b21600" }, { "name" : "clientId", "in" : "path", "description" : "The event managers will be retrieved based on the client id", "required" : true, "schema" : { "type" : "number" }, "example" : 18901 }, { "name" : "accept", "in" : "header", "description" : "Output format: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "example" : { "eventmanagers" : [ { "adminid" : "162295", "firstname" : "Amber", "lastname" : "Mahajan", "email" : "xxxxxxxx@inbfw.com", "primaryphone" : "9713124248", "secondaryphone" : "415-369-8000" } ] } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "The client id is not an Elite user/The adminId can not perform operations under client clientId; or You reached the maximum number of calls for this endpoint" } } } }, "/client/{clientId}/eventprofile" : { "get" : { "tags" : [ "Helpers" ], "summary" : "Retrieve Event Profiles", "description" : "Retrieves event profiles.", "operationId" : "Helpers.RetrieveEventProfiles", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The event profiles will be retrieved based on the client id", "required" : true, "schema" : { "type" : "number" }, "example" : 18901 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Output format: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" } ], "responses" : { "200" : { "content" : { "application/json" : { "example" : { "eventprofiles" : [ { "eventprofileid" : "918", "eventprofilename" : "Stonehenge Profile (918)" }, { "eventprofileid" : "1200", "eventprofilename" : "Stonehenge Profile (1200)" }, { "eventprofileid" : "1215", "eventprofilename" : "Stonehenge Profile (1215)" } ] } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "The client id is not an Elite user/The adminId can not perform operations under client clientId; or You reached the maximum number of calls for this endpoint" } } } }, "/client/{clientId}/eventtypes" : { "get" : { "tags" : [ "Helpers" ], "summary" : "Retrieve Event Types", "description" : "Retrieves event types for the given client account.", "operationId" : "Helpers.RetrieveEventTypes", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b21600" }, { "name" : "clientId", "in" : "path", "description" : "The event types will be retrieved based on the client id", "required" : true, "schema" : { "type" : "string" }, "example" : 18091 }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "example" : { "eventtypes" : [ { "label" : "Live Video and Audio", "value" : "fav" }, { "label" : "Simu-live", "value" : "simulive" }, { "label" : "Sim-2-live", "value" : "sim2live" }, { "label" : "Broadcast Video", "value" : "encodeonsite" }, { "label" : "On Demand", "value" : "ondemand" }, { "label" : "forum", "value" : "forum" }, { "label" : "Engagement Hub", "value" : "Engagement Hub" }, { "label" : "experience", "value" : "experience" }, { "label" : "Go Live", "value" : "Go Live" }, { "label" : "Go Live Session", "value" : "Go Live Session" }, { "label" : "Go Live Content", "value" : "Go Live Content" }, { "label" : "Go Live Location", "value" : "Go Live Location" }, { "label" : "Recurring Simulive", "value" : "Recurring Simulive" }, { "label" : "article", "value" : "article" }, { "label" : "image", "value" : "image" }, { "label" : "pdf", "value" : "pdf" }, { "label" : "podcast", "value" : "podcast" }, { "label" : "video", "value" : "video" }, { "label" : "webpage", "value" : "webpage" } ] } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "The client id is not an Elite user/The adminId can not perform operations under client clientId; or You reached the maximum number of calls for this endpoint" } } } }, "/client/{clientId}/forget" : { "post" : { "tags" : [ "REST Registration" ], "summary" : "Forget Registrant (client-level)", "description" : "Forgets personal data for all registrant data for a specific email address or multiple email addresses across an entire workspace, or for a specific event.\n\nThe following registrant fields are modified by this endpoint:\n\n- email = {event_user_id}-deleted\n- firstname = 'deleted'\n- lastname = 'deleted'\n- last_update = {Current date time}\n- last_update_by = adminid\n- company = NULL\n- address_street1 = NULL\n- address_street2 = NULL\n- city = NULL\n- state = NULL\n- event_user_ip = NULL\n- operating_system = NULL\n- browser = NULL\n- zip = NULL\n- home_phone = NULL\n- work_phone = NULL\n- fax = NULL\n- company_industry = NULL\n- username = NULL\n- job_function = NULL\n- company_size = NULL\n- ipnumber = NULL\n- longitude = NULL\n- latitude = NULL\n- job_title = NULL\n- std1 = NULL\n- std2 = NULL\n- std3 = NULL\n- std4 = NULL\n- std5 = NULL\n- std6 = NULL\n- std7 = NULL\n- std8 = NULL\n- std9 = NULL\n- std10 = NULL\n- country = NULL\n- event_email = 'N'\n- marketing_email = 'N'", "operationId" : "Registration.ForgetRegistrantClientlevel", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Application/json", "schema" : { "type" : "string", "default" : "Application/json" }, "example" : "Application/json" }, { "name" : "content-type", "in" : "header", "description" : "Possible values: \"application/x-www-form-urlencoded\" or \"multipart/formdata\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/ForgetRegistrantForm" } }, "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/ForgetRegistrantForm" } } } }, "responses" : { "200" : { "description" : "Registrant forgotten.", "content" : { "application/json" : { "example" : { "deletedregistrants" : { "eventuserids" : [ 23412341, 34563456, 56785678 ] } } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "You don't have access to this client id | You reached the maximum number of calls for this endpoint" }, "404" : { "description" : "No registrant was found for that email address" } } } }, "/client/{clientId}/forgetall" : { "post" : { "tags" : [ "REST Registration" ], "summary" : "Forget All Registrant (client-level)", "description" : "Forgets personal data for all registrant records in the specified workspace and all related sub-accounts.\n\n**NOTE: This will remove all data from all registrants, so this endpoint should be used with caution.**\n\nFollowing Registrant fields are modified by this endpoint:\n\n- email = {event_user_id}-deleted\n- firstname = 'deleted'\n- lastname = 'deleted'\n- last_update = {Current date time}\n- last_update_by = adminid\n- company = NULL\n- address_street1 = NULL\n- address_street2 = NULL\n- city = NULL\n- state = NULL\n- event_user_ip = NULL\n- operating_system = NULL\n- browser = NULL\n- zip = NULL\n- home_phone = NULL\n- work_phone = NULL\n- fax = NULL\n- company_industry = NULL\n- username = NULL\n- job_function = NULL\n- company_size = NULL\n- ipnumber = NULL\n- longitude = NULL\n- latitude = NULL\n- job_title = NULL\n- std1 = NULL\n- std2 = NULL\n- std3 = NULL\n- std4 = NULL\n- std5 = NULL\n- std6 = NULL\n- std7 = NULL\n- std8 = NULL\n- std9 = NULL\n- std10 = NULL\n- country = NULL\n- event_email = 'N'\n- marketing_email = 'N'", "operationId" : "Registration.ForgetAllRegistrantClientlevel", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "example" : 18091 }, { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "accept", "in" : "header", "description" : "Output format. possible values: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "Application/json" }, { "name" : "content-type", "in" : "header", "description" : "Possible values: \"application/x-www-form-urlencoded\" or \"multipart/formdata\"", "required" : true, "schema" : { "type" : "string" }, "example" : "application/x-www-form-urlencoded" } ], "responses" : { "200" : { "description" : "Registrant Forgotten.", "content" : { "application/json" : { "example" : { "deletedregistrants" : { "eventuserids" : [ 121120444, 121120456 ] } } } } }, "400" : { "description" : "You have exceeded the maximum number of user to be deleted (100,000)" }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "You don't have access to this client id | You reached the maximum number of calls for this endpoint" } } } }, "/client/{clientId}/languages" : { "get" : { "tags" : [ "Helpers" ], "summary" : "Retrieve Language Codes", "description" : "Retrieves language codes.", "operationId" : "Helpers.RetrieveLanguageCodes", "parameters" : [ { "name" : "accessTokenKey", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b21600" }, { "name" : "clientId", "in" : "path", "description" : "The language codes will be retrieved based on the client id", "required" : true, "schema" : { "type" : "number" }, "example" : 18901 }, { "name" : "accept", "in" : "header", "description" : "Output format: Application/xml or Application/json", "schema" : { "type" : "string", "default" : "application/json" }, "example" : "application/json" } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "example" : { "languagecodes" : [ { "label" : "English (UK)", "countrycd" : "UK", "languagecd" : "en" }, { "label" : "Portuguese", "languagecd" : "pt" }, { "label" : "Chinese (Simplified)", "countrycd" : "CN", "languagecd" : "zh" }, { "label" : "Chinese (Traditional)", "countrycd" : "TW", "languagecd" : "zh" } ] } } } }, "401" : { "description" : "The access token secret or access token key was not found" }, "403" : { "description" : "The client id is not an Elite user/The adminId can not perform operations under client clientId; or You reached the maximum number of calls for this endpoint" } } } }, "/client/{clientId}/lead" : { "get" : { "tags" : [ "Client Level Analytics" ], "summary" : "Leads", "description" : "Returns a listing of leads for a particular client. There is a limit of 50 leads per page.\n\n- If double opt-in verification was enabled at the time of registration for an event and a user has not completed the verification process, the user will not be included in any endpoint responses.", "operationId" : "AnalyticsClientLevel.Leads", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "dateInterval", "in" : "query", "description" : "Number of days returned in a response. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64" }, "example" : 30 }, { "name" : "dateIntervalOffset", "in" : "query", "description" : "Number of days from which the interval should encompass. See Rolling Interval.", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 4 }, { "name" : "dateIntervalTimezone", "in" : "query", "description" : "Timezone to be used for determining the 24 hour period that constitutes a day. See Rolling Interval.", "schema" : { "type" : "string", "default" : "America/Los_Angeles" }, "example" : "America/Los_Angeles" }, { "name" : "startdate", "in" : "query", "description" : "Limit results to users with registration date or attendance activity after startDate", "schema" : { "type" : "string", "default" : "30 days before current date" }, "example" : "2007-12-03" }, { "name" : "enddate", "in" : "query", "description" : "Limit results to users with registration date or attendance activity before endDate", "schema" : { "type" : "string", "default" : "current date" }, "example" : "2007-12-05" }, { "name" : "pageoffset", "in" : "query", "description" : "Selects the page to retrieve", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 1 }, { "name" : "itemsperpage", "in" : "query", "description" : "Number of items to be retrieved per page", "schema" : { "type" : "integer", "format" : "int64", "default" : 50 }, "example" : 25 } ], "responses" : { "200" : { "description" : "Return list of leads", "content" : { "application/json" : { "example" : { "clientid" : 22921, "totalleads" : 2, "pagecount" : 1, "currentpage" : 0, "leads" : [ { "email" : "xxxxxx@acme.com", "businessinterests" : [ "cars", "clowns" ], "engagementlevel" : "HIGH", "userprofileurl" : "https://data.on24.com/webcast/lead?token=yLw6HonT3FPP5-WFXrzDSus5yYRJs55zGUd9opGrJmFUC0t1TphOa47Vt_eYaAPM609CqsxjaColu2fthsldEJCVv9rxZuC00Uj9Uayp4X0=", "segments" : [ "USA & Canada Users", "C-level Registrants" ] }, { "email" : "xxxxxx@acme_inc.com", "businessinterests" : [ "clouds", "“hats”" ], "engagementprediction" : "LOW", "userprofileurl" : "https://data.on24.com/webcast/lead?token=yLw6FonT3FTT5-WFXrzDSus5yYRJs55zIUd9otGrJmHUC0t1TphOa47Vt_eYaATM609CqsxjaColu2fthsldEJCVv9rxZuC00Uj9Uayt4X0=", "segments" : [ "Europe Users", "C-level Registrants", "A-level Leads" ] } ] } } } }, "400" : { "description" : "startDate and endDate can't be more than 365 days appart. | Invalid pageOffset, range must be between 0 and XX." }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | Power Leads report is not enabled for client {clientId}." } } } }, "/client/{clientId}/lead/{email}" : { "get" : { "tags" : [ "Client Level Analytics" ], "summary" : "PEP", "description" : "Returns the Prospect Engagement Profile data for a specific email address.", "operationId" : "AnalyticsClientLevel.PEP", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "client access token key", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "client access token secret", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "email", "in" : "path", "description" : "lead email", "required" : true, "schema" : { "type" : "string" }, "example" : "test@domain.com" } ], "responses" : { "200" : { "description" : "Return PEP data", "content" : { "application/json" : { "examples" : { "when lead has attended at least one webinar" : { "description" : "when lead has attended at least one webinar", "value" : { "company" : "test company", "email" : "ddd@inbfw.co", "lastname" : "Y", "firstname" : "John Doe", "lifetimeactivity" : { "resources" : 1, "engagementlevel" : "HIGH", "totalengagementminutes" : 60, "totalengagementseconds" : 3615, "totaltouches" : 5, "webinarsattended" : 4, "videoswatched" : 0, "documentsread" : 0, "webpagesviewed" : 0 }, "businessinterests" : { "keywords" : [ "Widget", "Webcast", "Yahoo", "Polls", "Slidefromslide", "Status", "Send", "Push", "Cbnfgxhjgj", "Asnwer" ], "lastupdated" : "2018-09-27T03:15:32-07:00" }, "jobtitle" : "Senior Manager", "workphone" : "52162345664465465", "notes" : "example notes ", "recentactivities" : [ { "eventid" : 11094647, "liveseconds" : 3800, "livetime" : 63, "ondemandtime" : 0, "ondemandseconds" : 0, "eventtitle" : "Widget Report", "attendedarchive" : "N", "attendedlive" : "Y", "lastactivity" : "2018-08-27T04:33:14-07:00", "registrationdate" : "2018-08-27T02:33:43-07:00", "totalpages" : 0, "resourcesdownloaded" : 2, "askedquestions" : 1, "answeredpolls" : 1, "answeredsurveys" : 1, "ctasaccessed" : 3, "resources" : [ { "resourcename" : "facebook" }, { "resourcename" : "google" } ], "questions" : [ { "question" : "first question", "answer" : "Unanswered" } ], "polls" : [ { "question" : "безплатна услуга Google превежда незабавно думи, фрази и уеб страници между английски и.", "answer" : "FGHJKL" } ], "surveys" : [ { "question" : "ghjgyuikuoy", "answer" : "365" } ], "calltoactions" : [ { "ctaid" : "83970357", "ctaname" : "Call To Action 1", "clicks" : "3", "date" : "2015-05-19T11:10:00-07:00" } ], "eventuserid" : 224094098, "exteventusercd" : "1521" } ] } }, "no webinar attended" : { "description" : "no webinar attended", "value" : { "company" : "on24", "email" : "esteban.mora+testing-pep-predictive-engagement@on24.com", "lastname" : "mora", "firstname" : "Zapier client T-1", "lifetimeactivity" : { "resources" : 0, "totalengagementminutes" : 0, "totaltouches" : 0, "webinarsattended" : 0, "videoswatched" : 0, "documentsread" : 0, "webpagesviewed" : 0, "engagementprediction" : "MEDIUM" }, "businessinterests" : { "keywords" : [ ] }, "jobtitle" : "developer", "workphone" : "998324239847", "recentactivities" : [ ] } } } } } }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api." }, "404" : { "description" : "No lead data was found for that email address" } } } }, "/client/{clientId}/mediamanager" : { "get" : { "tags" : [ "Content Listings" ], "summary" : "Media Manager Derivative Content", "description" : "Retrieves the metadata for derivative content in Media Manager.\n\nOnly returns content from the clientId specified in the request, and does not pull content from sub-accounts.\n\nThere is a limit of 100 contents per page.\n\nDerivative content includes, and is limited to:\n\n- Nurture Page\n- Autogenerated Ebook\n- Autogenerated Blog Post\n- Autogenerated Key Takeaways\n- Transcript\n\nContent of type \"Nurture Page\" will always have a *contentid*.\n\nContent of type \"Nurture Page\" will never have a *mediaid*.\n\nContent of types \"Autogenerated Ebook\", \"Autogenerated Blog Post\", \"Autogenerated Key Takeaways\", and \"Transcript\" will always have a *mediaid*.\n\nContent of types \"Autogenerated Ebook\", \"Autogenerated Blog Post\", \"Autogenerated Key Takeaways\", and \"Transcript\" will only have a *contentid* after they are published for the first time.", "operationId" : "ContentListings.MediaManagerDerivativeContent", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "startdate", "in" : "query", "description" : "Limit results to those contents created after startDate. Max range between start and end dates can be up to 6 months.", "schema" : { "type" : "string", "format" : "date", "default" : "90 days before current date" }, "example" : "2007-12-03" }, { "name" : "enddate", "in" : "query", "description" : "Limit results to those contents created before endDate. Max range between start and end dates can be up to 6 months.", "schema" : { "type" : "string", "format" : "date", "default" : "current date" }, "example" : "2007-12-05" }, { "name" : "pageoffset", "in" : "query", "description" : "Selects the page to retrieve", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "example" : 1 }, { "name" : "itemsperpage", "in" : "query", "description" : "Number of items to be retrieved per page", "schema" : { "type" : "integer", "format" : "int64", "default" : 100 }, "example" : 25 } ], "responses" : { "200" : { "description" : "Return list of content", "content" : { "application/json" : { "example" : { "totalcontent" : 5, "pagecount" : 1, "currentpage" : 0, "contents" : [ { "contenttype" : "Nurture Page", "title" : "This is a title", "contentid" : 1775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/17/75/88/1/rt/1/images/thumbnail/sample.png", "url" : "https://gateway.on24.com/wcc/nurture/1775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name", "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ] }, { "contenttype" : "Autogenerated Ebook", "title" : "This is a title", "contentid" : 83316436, "mediaid" : 2775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/27/75/88/1/rt/1/images/thumbnail/sample.png", "urls" : [ { "parentid" : 1245667, "url" : "https://gateway.on24.com/wcc/nurture/2775881/25D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" }, { "parentid" : 9876441, "url" : "https://gateway.on24.com/wcc/nurture/9775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ] }, { "contenttype" : "Autogenerated Blog Post", "title" : "This is a title", "mediaid" : 3775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/37/75/88/1/rt/1/images/thumbnail/sample.png", "urls" : [ { "parentid" : 1245667, "url" : "https://gateway.on24.com/wcc/nurture/2775881/25D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" }, { "parentid" : 9876441, "url" : "https://gateway.on24.com/wcc/nurture/9775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ] }, { "contenttype" : "Autogenerated Key Takeaways", "title" : "This is a title", "contentid" : 83334439, "mediaid" : 4775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/47/75/88/1/rt/1/images/thumbnail/sample.png", "urls" : [ { "parentid" : 1245667, "url" : "https://gateway.on24.com/wcc/nurture/2775881/25D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" }, { "parentid" : 9876441, "url" : "https://gateway.on24.com/wcc/nurture/9775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ] }, { "contenttype" : "Transcript", "title" : "This is a title", "mediaid" : 5775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/57/75/88/1/rt/1/images/thumbnail/sample.png", "urls" : [ { "parentid" : 1245667, "url" : "https://gateway.on24.com/wcc/nurture/2775881/25D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" }, { "parentid" : 9876441, "url" : "https://gateway.on24.com/wcc/nurture/9775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ] } ] } } } }, "400" : { "description" : "Bad request" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid" }, "403" : { "description" : "You do not have permission to perform the requested operation | You have reached the maximum number of calls for this api | The client id {clientId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist" } } } }, "/client/{clientId}/mediamanager/document" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Media Manager Upload Document", "description" : "Upload a document to Media Manager.\n\n### Supported File Types\n\n- .pdf\n- .jpg\n- .jpeg\n- .png\n\n### File Max Size\n\n- 10 GB", "operationId" : "EventManagement.MediaManagerUploadDocument", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/UploadDocumentForm" } } } }, "responses" : { "200" : { "description" : "File queued to be processed", "content" : { "application/json" : { "example" : { "message" : "RECEIVED", "mediafile" : "myFile.pdf" } } } }, "400" : { "description" : "File is not accepted filetype" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist" }, "500" : { "description" : "Response code from uploading service is not success" } } } }, "/client/{clientId}/mediamanager/uploadvideo" : { "post" : { "tags" : [ "Event Management" ], "summary" : "Media Manager Upload Video", "description" : "Upload a video to Media Manager.\n\n### Supported File Types\n\n- .mp4\n- .wmv\n- .mov\n- .mp3\n- .flv\n- .avi\n\n### File Max Size\n\n- 10gb", "operationId" : "EventManagement.MediaManagerUploadVideo", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/UploadVideoForm" } } } }, "responses" : { "200" : { "description" : "File queued to be processed", "content" : { "application/json" : { "example" : { "message" : "RECEIVED", "mediafile" : "myFile.mp4" } } } }, "400" : { "description" : "File is not accepted filetype" }, "401" : { "description" : "AccessTokenKey and AccessTokenSecret are wrong or invalid." }, "403" : { "description" : "You do not have permission to perform the requested operation. | You have reached the maximum number of calls for this api. | The client id {clientId} is inactive" }, "404" : { "description" : "The client {clientId} doesn't exist" }, "500" : { "description" : "Response code from uploading service is not success" } } } }, "/client/{clientId}/mediamanager/{mediaId}" : { "get" : { "tags" : [ "Content Listings" ], "summary" : "Media Manager Derivative Content Text", "description" : "Retrieves the metadata for a particular derivative content in Media Manager, identified by *mediaId*.\n\n**Derivative content supported:**\n\n- Autogenerated Ebook\n- Autogenerated Blog Post\n- Autogenerated Key Takeaways\n- Transcript", "operationId" : "ContentListings.MediaManagerDerivativeContentText", "parameters" : [ { "name" : "clientId", "in" : "path", "description" : "The client id", "required" : true, "schema" : { "type" : "string" }, "example" : 15448 }, { "name" : "accessTokenKey", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "63129107067A520E6B7DE18D5E1CB2BF" }, { "name" : "accessTokenSecret", "in" : "header", "description" : "Security Parameter", "required" : true, "schema" : { "type" : "string" }, "example" : "072639740ac239333e3708a1623b9de3590d972e6b1060071b726ecfd9b216001b45391717d9fbeb780438" }, { "name" : "mediaId", "in" : "path", "description" : "The media id of the content requested", "required" : true, "schema" : { "type" : "string" }, "example" : 2775881 } ], "responses" : { "200" : { "description" : "Returns content metadata", "content" : { "application/json" : { "example" : { "contenttype" : "Transcript", "title" : "This is a title", "mediaid" : 5775881, "sourceeventid" : 2478889, "sourceeventtitle" : "Some Webinar Name", "createddate" : "2023-02-02T03:20:00-08:00", "createdby" : "Joe Smith", "thumbnail" : "http://gateway.on24.com/event/57/75/88/1/rt/1/images/thumbnail/sample.png", "urls" : [ { "parentid" : 1245667, "url" : "https://gateway.on24.com/wcc/nurture/2775881/25D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" }, { "parentid" : 9876441, "url" : "https://gateway.on24.com/wcc/nurture/9775881/95D40D5588A0B7BF420C5976C78DE19B/some-webinar-name" } ], "tags" : [ { "name" : "Tag 1" }, { "name" : "Tag 2" }, { "name" : "Tag 3" } ], "funnelstages" : [ { "name" : "Awareness" }, { "name" : "Consideration" }, { "name" : "Evaluation" }, { "name" : "Retention" } ], "text" : "