{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:qualtrics/create-contact-in-mailinglist":{"post":{"operationId":"business_qualtrics_create_contact_in_mailinglist","summary":"Create contact in mailing list","description":"POST /directories/{DirectoryId}/mailinglists/{MailingListId}/contacts","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DirectoryId","MailingListId","body"],"properties":{"DirectoryId":{"type":"string","description":"ID of the qualtrics directory to create the contact to"},"MailingListId":{"type":"string","description":"ID of the mailing list"},"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/business:qualtrics/get-distributions":{"get":{"operationId":"business_qualtrics_get_distributions","summary":"Get distributions for survey","description":"GET /distributions","tags":["business"],"parameters":[{"name":"surveyId","in":"query","required":true,"description":"The survey for which to load the distributions","schema":{"type":"string","description":"The survey for which to load the distributions"}}],"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/business:qualtrics/generate-distribution-links":{"post":{"operationId":"business_qualtrics_generate_distribution_links","summary":"Generate distribution links","description":"POST /distributions","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/business:qualtrics/retrievedistributionlinks":{"get":{"operationId":"business_qualtrics_retrievedistributionlinks","summary":"Retrieve distribution links","description":"GET /distributions/{DistributionId}/links","tags":["business"],"parameters":[{"name":"surveyId","in":"query","required":true,"description":"ID of the survey (eg: SV_123)","schema":{"type":"string","description":"ID of the survey (eg: SV_123)"}},{"name":"DistributionId","in":"query","required":true,"description":"ID of the distribution list","schema":{"type":"string","description":"ID of the distribution list"}}],"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/business:qualtrics/when-aresponse-is-received":{"post":{"operationId":"business_qualtrics_when_aresponse_is_received","summary":"Triggers when a response is submitted to a qualtrics survey","description":"POST /eventsubscriptions/","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/business:qualtrics/webhook-delete":{"post":{"operationId":"business_qualtrics_webhook_delete","summary":"Remove subscription to response event","description":"DELETE /eventsubscriptions/","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/business:qualtrics/get-event-subscriptions":{"get":{"operationId":"business_qualtrics_get_event_subscriptions","summary":"Get event subscriptions","description":"GET /eventsubscriptions/{SubscriptionId}","tags":["business"],"parameters":[{"name":"SubscriptionId","in":"query","required":true,"description":"ID of event subscription - can be obtained from web hook response","schema":{"type":"string","description":"ID of event subscription - can be obtained from web hook response"}}],"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/business:qualtrics/get-survey":{"get":{"operationId":"business_qualtrics_get_survey","summary":"Get survey","description":"GET /survey-definitions/{SurveyId}","tags":["business"],"parameters":[{"name":"SurveyId","in":"query","required":true,"description":"ID of survey (eg. SV_123)","schema":{"type":"string","description":"ID of survey (eg. SV_123)"}}],"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":"dev-tools:hash"},"data":{},"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"}}}}}}}