{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:surfly/agents-get-list":{"get":{"operationId":"open_data_surfly_agents_get_list","summary":"List","description":"GET /agents/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"free","in":"query","required":false,"description":"Agents that are ready to take a call. Depends on `available` field value and online status.","schema":{"type":"boolean","description":"Agents that are ready to take a call. Depends on `available` field value and online status."}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/agents-register-new-agent":{"post":{"operationId":"open_data_surfly_agents_register_new_agent","summary":"Create","description":"POST /agents/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["API_KEY","body"],"properties":{"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/agents-get-by-id":{"get":{"operationId":"open_data_surfly_agents_get_by_id","summary":"Get by id","description":"GET /agents/{AGENT_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"API_KEY","in":"query","required":true,"schema":{"type":"string"}},{"name":"AGENT_ID","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/agents-update-agent":{"post":{"operationId":"open_data_surfly_agents_update_agent","summary":"Update","description":"PUT /agents/{AGENT_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AGENT_ID","API_KEY","body"],"properties":{"AGENT_ID":{"type":"string","description":"Id of the agent to update"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/agents-remove-agent":{"post":{"operationId":"open_data_surfly_agents_remove_agent","summary":"Delete","description":"DELETE /agents/{AGENT_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AGENT_ID","API_KEY"],"properties":{"AGENT_ID":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/agents-generate-access-token":{"post":{"operationId":"open_data_surfly_agents_generate_access_token","summary":"Generate an access token","description":"POST /agents/access-token/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["API_KEY","body"],"properties":{"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/sessions-get-all":{"get":{"operationId":"open_data_surfly_sessions_get_all","summary":"List","description":"GET /sessions/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/sessions-generate-new-session":{"post":{"operationId":"open_data_surfly_sessions_generate_new_session","summary":"Create","description":"POST /sessions/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["API_KEY","body"],"properties":{"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/sessions-filter":{"get":{"operationId":"open_data_surfly_sessions_filter","summary":"Filter","description":"GET /sessions/?api_key={api_key}&active_session={active_session}&agent_id={agent_id}&year={year}&month={month}&pin={pin}&tags={tags}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"active_session","in":"query","required":true,"description":"Filter active or inactive sessions","schema":{"type":"boolean","description":"Filter active or inactive sessions"}},{"name":"agent_id","in":"query","required":true,"description":"Filter by ID of the agent who joined/started a session","schema":{"type":"number","description":"Filter by ID of the agent who joined/started a session"}},{"name":"year","in":"query","required":true,"description":"Filter by year","schema":{"type":"number","description":"Filter by year"}},{"name":"month","in":"query","required":true,"description":"Filter by month","schema":{"type":"number","description":"Filter by month"}},{"name":"pin","in":"query","required":true,"description":"Filter by PIN number (useful in combination with `active_session`)","schema":{"type":"number","description":"Filter by PIN number (useful in combination with `active_session`)"}},{"name":"tags","in":"query","required":true,"description":"Filter by tag. Supports multiple comma separated tags at once","schema":{"type":"string","description":"Filter by tag. Supports multiple comma separated tags at once"}},{"name":"api_key","in":"query","required":true,"description":"Path parameter {api_key}","schema":{"type":"string","description":"Path parameter {api_key}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/sessions-get-by-id":{"get":{"operationId":"open_data_surfly_sessions_get_by_id","summary":"Get by id","description":"GET /sessions/{ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"ID","in":"query","required":true,"description":"Id of the session. Can be a formatted ID (e.g. 123-123-123), or an unformatted ID (e.g. fuSHr0sRQ1usugvheahwQ)","schema":{"type":"string","description":"Id of the session. Can be a formatted ID (e.g. 123-123-123), or an unformatted ID (e.g. fuSHr0sRQ1usugvheahwQ)"}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/sessions-end-by-id":{"post":{"operationId":"open_data_surfly_sessions_end_by_id","summary":"End","description":"POST /sessions/{ID}/end/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ID","API_KEY"],"properties":{"ID":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/company-get-default-options":{"get":{"operationId":"open_data_surfly_company_get_default_options","summary":"Get default options","description":"GET /company/options/?api_key={api_key}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"api_key","in":"query","required":true,"description":"Path parameter {api_key}","schema":{"type":"string","description":"Path parameter {api_key}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/company-post-options":{"post":{"operationId":"open_data_surfly_company_post_options","summary":"Post options","description":"POST /company/options/?api_key={api_key}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key"],"properties":{"api_key":{"type":"string","description":"Path parameter {api_key}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/company-update-default-options":{"post":{"operationId":"open_data_surfly_company_update_default_options","summary":"Update default options","description":"PATCH /company/options/?api_key={api_key}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key"],"properties":{"api_key":{"type":"string","description":"Path parameter {api_key}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/company-reset-default-options":{"post":{"operationId":"open_data_surfly_company_reset_default_options","summary":"Reset default options","description":"DELETE /company/options/?api_key={api_key}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key"],"properties":{"api_key":{"type":"string","description":"Path parameter {api_key}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/screenshots-get-latest":{"get":{"operationId":"open_data_surfly_screenshots_get_latest","summary":"Latest Screenshot","description":"GET /sessions/{ID}/screenshots/latest/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"ID","in":"query","required":true,"schema":{"type":"string"}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/screenshots-start-generation":{"post":{"operationId":"open_data_surfly_screenshots_start_generation","summary":"Create Screenshot","description":"POST /sessions/{ID}/screenshots/create/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ID","API_KEY","body"],"properties":{"ID":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-get-all":{"get":{"operationId":"open_data_surfly_clients_get_all","summary":"List","description":"GET /clients/all/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-add-new-client":{"post":{"operationId":"open_data_surfly_clients_add_new_client","summary":"Create","description":"POST /clients/all/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["API_KEY","body"],"properties":{"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-info-by-id":{"get":{"operationId":"open_data_surfly_clients_info_by_id","summary":"Get by Id","description":"GET /clients/all/{CLIENT_KEY}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"CLIENT_KEY","in":"query","required":true,"schema":{"type":"string"}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-set-domain-list":{"post":{"operationId":"open_data_surfly_clients_set_domain_list","summary":"Set Client Domain List","description":"POST /clients/all/{CLIENT_KEY}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CLIENT_KEY","API_KEY","body"],"properties":{"CLIENT_KEY":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-update-client":{"post":{"operationId":"open_data_surfly_clients_update_client","summary":"Update","description":"PUT /clients/all/{CLIENT_KEY}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CLIENT_KEY","API_KEY","body"],"properties":{"CLIENT_KEY":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-delete-client":{"post":{"operationId":"open_data_surfly_clients_delete_client","summary":"Delete","description":"DELETE /clients/all/{CLIENT_KEY}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CLIENT_KEY","API_KEY"],"properties":{"CLIENT_KEY":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/clients-list-active-sessions-for-reseller-client":{"get":{"operationId":"open_data_surfly_clients_list_active_sessions_for_reseller_client","summary":"List Active Sessions for Reseller's Client","description":"GET /sessions/?api_key={API_KEY}&clientkey={CLIENT_KEY}&active_session=true&year=2015&month=01","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"CLIENT_KEY","in":"query","required":true,"schema":{"type":"string"}},{"name":"active_session","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"year","in":"query","required":false,"schema":{"type":"integer"}},{"name":"month","in":"query","required":false,"schema":{"type":"integer"}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/history-get-all-sessions":{"get":{"operationId":"open_data_surfly_history_get_all_sessions","summary":"List","description":"GET /history/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/history-filter-session-history":{"get":{"operationId":"open_data_surfly_history_filter_session_history","summary":"Filter session history","description":"GET /history/?api_key={api_key}&active_session={active_session}&agent_id={agent_id}&pin={pin}&tags={tags}&min_duration={min_duration}&max_duration={max_duration}&min_date={min_date}&max_date={max_date}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"active_session","in":"query","required":true,"description":"Filter active or inactive sessions. Takes `true` or `false`.","schema":{"type":"boolean","description":"Filter active or inactive sessions. Takes `true` or `false`."}},{"name":"agent_id","in":"query","required":true,"description":"Filter by ID of the agent who joined/started a session. Can take `null` as a value.","schema":{"type":"string","description":"Filter by ID of the agent who joined/started a session. Can take `null` as a value."}},{"name":"pin","in":"query","required":true,"description":"Filter by session pin. Can take `null` as a value.","schema":{"type":"string","description":"Filter by session pin. Can take `null` as a value."}},{"name":"tags","in":"query","required":true,"description":"Filter by session tag. Can take `null` as a value.","schema":{"type":"string","description":"Filter by session tag. Can take `null` as a value."}},{"name":"min_duration","in":"query","required":true,"description":"Filter by minimum duration of a session.","schema":{"type":"number","description":"Filter by minimum duration of a session."}},{"name":"max_duration","in":"query","required":true,"description":"Filter by maximum duration of a session.","schema":{"type":"number","description":"Filter by maximum duration of a session."}},{"name":"min_date","in":"query","required":true,"description":"Filter by earlist start date/time. Accepts a timestamp in iso8601 format. Make sure to take the timezone into account","schema":{"type":"string","description":"Filter by earlist start date/time. Accepts a timestamp in iso8601 format. Make sure to take the timezone into account"}},{"name":"max_date","in":"query","required":true,"description":"Filter by latest start date/time. Accepts a timestamp in iso8601 format. Make sure to take the timezone into account","schema":{"type":"string","description":"Filter by latest start date/time. Accepts a timestamp in iso8601 format. Make sure to take the timezone into account"}},{"name":"api_key","in":"query","required":true,"description":"Path parameter {api_key}","schema":{"type":"string","description":"Path parameter {api_key}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/webhooks-list-all":{"get":{"operationId":"open_data_surfly_webhooks_list_all","summary":"List","description":"GET /webhooks/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/webhooks-create-webhook":{"post":{"operationId":"open_data_surfly_webhooks_create_webhook","summary":"Create","description":"POST /webhooks/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["API_KEY","body"],"properties":{"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/webhooks-get-webhook-information":{"get":{"operationId":"open_data_surfly_webhooks_get_webhook_information","summary":"Get by Id","description":"GET /webhooks/{WEBHOOK_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"WEBHOOK_ID","in":"query","required":true,"schema":{"type":"string"}},{"name":"API_KEY","in":"query","required":true,"description":"Path parameter {API_KEY}","schema":{"type":"string","description":"Path parameter {API_KEY}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:surfly/webhooks-update-webhook":{"post":{"operationId":"open_data_surfly_webhooks_update_webhook","summary":"Update","description":"PUT /webhooks/{WEBHOOK_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WEBHOOK_ID","API_KEY","body"],"properties":{"WEBHOOK_ID":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/webhooks-remove-webhook":{"post":{"operationId":"open_data_surfly_webhooks_remove_webhook","summary":"Delete an Webhook","description":"DELETE /webhooks/{WEBHOOK_ID}/?api_key={API_KEY}","tags":["open-data"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WEBHOOK_ID","API_KEY"],"properties":{"WEBHOOK_ID":{"type":"string"},"API_KEY":{"type":"string","description":"Path parameter {API_KEY}"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:surfly/servers-list-available":{"get":{"operationId":"open_data_surfly_servers_list_available","summary":"List","description":"GET /servers","tags":["open-data"],"x-apizie-access":"read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}