{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/social-media:contribly/get-artifact-formats":{"get":{"operationId":"social_media_contribly_get_artifact_formats","summary":"Artifact formats","description":"GET /artifact-formats","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-assignments":{"get":{"operationId":"social_media_contribly_get_assignments","summary":"List assignments","description":"GET /assignments","tags":["social-media"],"parameters":[{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to assignments owned by this user.","schema":{"type":"string","description":"Restrict results to assignments owned by this user."}},{"name":"page","in":"query","required":false,"description":"Pagination page","schema":{"type":"integer","description":"Pagination page"}},{"name":"pageSize","in":"query","required":false,"description":"Pagination page size","schema":{"type":"integer","description":"Pagination page size"}},{"name":"q","in":"query","required":false,"description":"Restrict results to assignments whose name or description matches this keyword.","schema":{"type":"string","description":"Restrict results to assignments whose name or description matches this keyword."}},{"name":"urlWords","in":"query","required":false,"description":"Select an assignment by urlWords.","schema":{"type":"string","description":"Select an assignment by urlWords."}},{"name":"open","in":"query","required":false,"description":"Select open or closed assignments","schema":{"type":"boolean","description":"Select open or closed assignments"}},{"name":"alwaysOpen","in":"query","required":false,"description":"Select assignments with no closing date.","schema":{"type":"boolean","description":"Select assignments with no closing date."}},{"name":"tag","in":"query","required":false,"description":"Restrict results to assignments which are tagged with this tag.","schema":{"type":"string","description":"Restrict results to assignments which are tagged with this tag."}},{"name":"name","in":"query","required":false,"description":"Restrict results to the assignment (or potentially assignments) with this exact name","schema":{"type":"string","description":"Restrict results to the assignment (or potentially assignments) with this exact name"}}],"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/social-media:contribly/post-assignments":{"post":{"operationId":"social_media_contribly_post_assignments","summary":"Create a new assignment","description":"POST /assignments","tags":["social-media"],"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/social-media:contribly/get-assignments-id":{"get":{"operationId":"social_media_contribly_get_assignments_id","summary":"Get a single assigment by id","description":"GET /assignments/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the assignment to return","schema":{"type":"string","description":"Id of the assignment to return"}}],"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/social-media:contribly/delete-assignments-id":{"post":{"operationId":"social_media_contribly_delete_assignments_id","summary":"Delete this assignment and all of it's contributions","description":"DELETE /assignments/{id}","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the assignment to return"}}}}}},"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/social-media:contribly/get-change-log":{"get":{"operationId":"social_media_contribly_get_change_log","summary":"Recent changes","description":"GET /change-log","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-contribution-refinement-types":{"get":{"operationId":"social_media_contribly_get_contribution_refinement_types","summary":"List valid contribution refinement types","description":"GET /contribution-refinement-types","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-contribution-refinements":{"get":{"operationId":"social_media_contribly_get_contribution_refinements","summary":"List contribution refinement options","description":"GET /contribution-refinements","tags":["social-media"],"parameters":[{"name":"assignment","in":"query","required":false,"description":"Restrict results to contributions submitted to this assignment.","schema":{"type":"string","description":"Restrict results to contributions submitted to this assignment."}},{"name":"country","in":"query","required":false,"description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).","schema":{"type":"string","description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code)."}},{"name":"createdBefore","in":"query","required":false,"description":"Limit results to contributions created before this date time.","schema":{"type":"string","description":"Limit results to contributions created before this date time."}},{"name":"createdAfter","in":"query","required":false,"description":"Limit results to contributions created after this date time.","schema":{"type":"string","description":"Limit results to contributions created after this date time."}},{"name":"geohash","in":"query","required":false,"description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…","schema":{"type":"string","description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…"}},{"name":"hasLocation","in":"query","required":false,"description":"Restrict results to contributions which have a publicly visible location.","schema":{"type":"boolean","description":"Restrict results to contributions which have a publicly visible location."}},{"name":"latLong","in":"query","required":false,"description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius","schema":{"type":"string","description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius"}},{"name":"radius","in":"query","required":false,"description":"When limiting result by location with the latLong parameter, specify the radius in kilometers.","schema":{"type":"number","description":"When limiting result by location with the latLong parameter, specify the radius in kilometers."}},{"name":"mediaType","in":"query","required":false,"description":"Restrict results to contributions which include a media file of the given type (ie. image / video)","schema":{"type":"string","description":"Restrict results to contributions which include a media file of the given type (ie. image / video)"}},{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to contributions which are fall under the jurisdiction by this user.","schema":{"type":"string","description":"Restrict results to contributions which are fall under the jurisdiction by this user."}},{"name":"q","in":"query","required":false,"description":"Restrict results to contributions whose headline text matches this keyword.","schema":{"type":"string","description":"Restrict results to contributions whose headline text matches this keyword."}},{"name":"urlWords","in":"query","required":false,"description":"Locate a specific contribution by URL words","schema":{"type":"string","description":"Locate a specific contribution by URL words"}},{"name":"user","in":"query","required":false,"description":"Restrict results to contributions by this user identified by id.","schema":{"type":"string","description":"Restrict results to contributions by this user identified by id."}},{"name":"refinements","in":"query","required":false,"description":"Comma seperated list of refinement names.","schema":{"type":"string","description":"Comma seperated list of refinement names."}},{"name":"refinementSize","in":"query","required":false,"description":"Number of refinement options to return.","schema":{"type":"number","description":"Number of refinement options to return."}}],"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/social-media:contribly/get-contributions":{"get":{"operationId":"social_media_contribly_get_contributions","summary":"List contributions","description":"GET /contributions","tags":["social-media"],"parameters":[{"name":"assignment","in":"query","required":false,"description":"Restrict results to contributions submitted to this assignment.","schema":{"type":"string","description":"Restrict results to contributions submitted to this assignment."}},{"name":"country","in":"query","required":false,"description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).","schema":{"type":"string","description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code)."}},{"name":"createdBefore","in":"query","required":false,"description":"Limit results to contributions created before this date time.","schema":{"type":"string","description":"Limit results to contributions created before this date time."}},{"name":"createdAfter","in":"query","required":false,"description":"Limit results to contributions created after this date time.","schema":{"type":"string","description":"Limit results to contributions created after this date time."}},{"name":"createdDay","in":"query","required":false,"description":"Limit results to contributions created on this day.","schema":{"type":"string","description":"Limit results to contributions created on this day."}},{"name":"createdMonth","in":"query","required":false,"description":"Limit results to contributions created during this month.","schema":{"type":"string","description":"Limit results to contributions created during this month."}},{"name":"geohash","in":"query","required":false,"description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…","schema":{"type":"string","description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…"}},{"name":"hasLocation","in":"query","required":false,"description":"Restrict results to contributions which have a publicly visible location.","schema":{"type":"boolean","description":"Restrict results to contributions which have a publicly visible location."}},{"name":"latLong","in":"query","required":false,"description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius","schema":{"type":"string","description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius"}},{"name":"radius","in":"query","required":false,"description":"When limiting result by location with the latLong parameter, specify the radius in kilometers.","schema":{"type":"number","description":"When limiting result by location with the latLong parameter, specify the radius in kilometers."}},{"name":"mediaType","in":"query","required":false,"description":"Restrict results to contributions which include a media file of the given type (ie. image / video)","schema":{"type":"string","description":"Restrict results to contributions which include a media file of the given type (ie. image / video)"}},{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to contributions which are fall under the jurisdiction by this user.","schema":{"type":"string","description":"Restrict results to contributions which are fall under the jurisdiction by this user."}},{"name":"q","in":"query","required":false,"description":"Restrict results to contributions whose headline text matches this keyword.","schema":{"type":"string","description":"Restrict results to contributions whose headline text matches this keyword."}},{"name":"urlWords","in":"query","required":false,"description":"Locate a specific contribution by URL words","schema":{"type":"string","description":"Locate a specific contribution by URL words"}},{"name":"user","in":"query","required":false,"description":"Restrict results to contributions by this user identified by id.","schema":{"type":"string","description":"Restrict results to contributions by this user identified by id."}},{"name":"ids","in":"query","required":false,"description":"Restrict results to a list of specific contributions identified by a comma seperated list of ids.","schema":{"type":"string","description":"Restrict results to a list of specific contributions identified by a comma seperated list of ids."}},{"name":"format","in":"query","required":false,"description":"Select output format. 'json' or 'rss'. Defaults to JSON.","schema":{"type":"string","description":"Select output format. 'json' or 'rss'. Defaults to JSON."}}],"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/social-media:contribly/post-contributions":{"post":{"operationId":"social_media_contribly_post_contributions","summary":"Create a new contribution","description":"POST /contributions","tags":["social-media"],"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/social-media:contribly/get-contributions-id":{"get":{"operationId":"social_media_contribly_get_contributions_id","summary":"Get a single contribution by id","description":"GET /contributions/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the contribution to return","schema":{"type":"string","description":"Id of the contribution to return"}}],"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/social-media:contribly/delete-contributions-id":{"post":{"operationId":"social_media_contribly_delete_contributions_id","summary":"Delete this contribution","description":"DELETE /contributions/{id}","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the contribution to delete"}}}}}},"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/social-media:contribly/post-contributions-id-flag":{"post":{"operationId":"social_media_contribly_post_contributions_id_flag","summary":"Raise a flag against this contribution","description":"POST /contributions/{id}/flag","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Id of the contribution to flag"},"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/social-media:contribly/post-contributions-id-like":{"post":{"operationId":"social_media_contribly_post_contributions_id_like","summary":"Allows a user to mark a contribution as liked","description":"POST /contributions/{id}/like","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the contribution"}}}}}},"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/social-media:contribly/get-contributions-id-likes":{"get":{"operationId":"social_media_contribly_get_contributions_id_likes","summary":"List users who have liked this contributions","description":"GET /contributions/{id}/likes","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the contribution","schema":{"type":"string","description":"Id of the contribution"}}],"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/social-media:contribly/post-contributions-id-moderate":{"post":{"operationId":"social_media_contribly_post_contributions_id_moderate","summary":"Perform a moderation action on this contribution","description":"POST /contributions/{id}/moderate","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Id of the contribution to moderate"},"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/social-media:contribly/get-credentials":{"get":{"operationId":"social_media_contribly_get_credentials","summary":"List the credentials associated with the authenticated user.","description":"GET /credentials","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-event-types":{"get":{"operationId":"social_media_contribly_get_event_types","summary":"Event types","description":"GET /event-types","tags":["social-media"],"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"}},"/v1/social-media:contribly/post-export":{"post":{"operationId":"social_media_contribly_post_export","summary":"Export contributions.","description":"POST /export","tags":["social-media"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assignment":{"type":"string","description":"Restrict results to contributions submitted to this assignment."},"country":{"type":"string","description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code)."},"createdBefore":{"type":"string","description":"Limit results to contributions created before this date time."},"createdAfter":{"type":"string","description":"Limit results to contributions created after this date time."},"geohash":{"type":"string","description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…"},"hasLocation":{"type":"boolean","description":"Restrict results to contributions which have a publicly visible location."},"latLong":{"type":"string","description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius"},"radius":{"type":"number","description":"When limiting result by location with the latLong parameter, specify the radius in kilometers."},"mediaType":{"type":"string","description":"Restrict results to contributions which include a media file of the given type (ie. image / video)"},"ownedBy":{"type":"string","description":"Restrict results to contributions which are fall under the jurisdiction by this user."},"q":{"type":"string","description":"Restrict results to contributions whose headline text matches this keyword."},"urlWords":{"type":"string","description":"Locate a specific contribution by URL words"},"user":{"type":"string","description":"Restrict results to contributions by this user identified by id."},"tagged":{"type":"boolean","description":"Should exported media files be tagged with metadata. Deprecated; use format instead."},"combined":{"type":"boolean","description":"Included a combined file with all contribution text."},"individual":{"type":"boolean","description":"Include individual text files for each contribution."},"format":{"type":"string","description":"Media format to export; none, fullsize, tagged or original."},"json":{"type":"boolean","description":"Include raw JSON for each contribution."}}}}}},"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/social-media:contribly/post-export-summary":{"post":{"operationId":"social_media_contribly_post_export_summary","summary":"Export contributions preflight summary.","description":"POST /export-summary","tags":["social-media"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assignment":{"type":"string","description":"Restrict results to contributions submitted to this assignment."},"country":{"type":"string","description":"Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code)."},"createdBefore":{"type":"string","description":"Limit results to contributions created before this date time."},"createdAfter":{"type":"string","description":"Limit results to contributions created after this date time."},"geohash":{"type":"string","description":"Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple…"},"hasLocation":{"type":"boolean","description":"Restrict results to contributions which have a publicly visible location."},"latLong":{"type":"string","description":"Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius"},"radius":{"type":"number","description":"When limiting result by location with the latLong parameter, specify the radius in kilometers."},"mediaType":{"type":"string","description":"Restrict results to contributions which include a media file of the given type (ie. image / video)"},"ownedBy":{"type":"string","description":"Restrict results to contributions which are fall under the jurisdiction by this user."},"q":{"type":"string","description":"Restrict results to contributions whose headline text matches this keyword."},"urlWords":{"type":"string","description":"Locate a specific contribution by URL words"},"user":{"type":"string","description":"Restrict results to contributions by this user identified by id."}}}}}},"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/social-media:contribly/get-exports-id":{"get":{"operationId":"social_media_contribly_get_exports_id","summary":"Get a single export job; poll to follow export progress.","description":"GET /exports/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the export job to return","schema":{"type":"string","description":"Id of the export job to return"}}],"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/social-media:contribly/get-form-responses":{"get":{"operationId":"social_media_contribly_get_form_responses","summary":"List form responses","description":"GET /form-responses","tags":["social-media"],"parameters":[{"name":"user","in":"query","required":false,"description":"Restrict results to responses submitted by this user.","schema":{"type":"string","description":"Restrict results to responses submitted by this user."}},{"name":"form","in":"query","required":false,"description":"Restrict results to responses submitted to this form.","schema":{"type":"string","description":"Restrict results to responses submitted to this form."}},{"name":"contribution","in":"query","required":false,"description":"Restrict results to responses relating to this contribution.","schema":{"type":"string","description":"Restrict results to responses relating to this contribution."}}],"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/social-media:contribly/post-form-responses":{"post":{"operationId":"social_media_contribly_post_form_responses","summary":"Submit a response to a form","description":"POST /form-responses","tags":["social-media"],"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/social-media:contribly/get-form-responses-id":{"get":{"operationId":"social_media_contribly_get_form_responses_id","summary":"Get a single form response by id","description":"GET /form-responses/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the assignment to return","schema":{"type":"string","description":"Id of the assignment to return"}}],"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/social-media:contribly/get-forms":{"get":{"operationId":"social_media_contribly_get_forms","summary":"List forms","description":"GET /forms","tags":["social-media"],"parameters":[{"name":"ownedBy","in":"query","required":true,"description":"Restrict results to forms owned by this user.","schema":{"type":"string","description":"Restrict results to forms owned by this user."}}],"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/social-media:contribly/post-forms":{"post":{"operationId":"social_media_contribly_post_forms","summary":"Create a form","description":"POST /forms","tags":["social-media"],"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/social-media:contribly/get-forms-id":{"get":{"operationId":"social_media_contribly_get_forms_id","summary":"Get a single form by id","description":"GET /forms/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the form to return","schema":{"type":"string","description":"Id of the form to return"}}],"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/social-media:contribly/delete-forms-id":{"post":{"operationId":"social_media_contribly_delete_forms_id","summary":"Delete this form and all of it's responses.","description":"DELETE /forms/{id}","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the form to delete"}}}}}},"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/social-media:contribly/post-media":{"post":{"operationId":"social_media_contribly_post_media","summary":"Submit a new media file","description":"POST /media","tags":["social-media"],"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/social-media:contribly/get-notifications-contributions-id-preview":{"get":{"operationId":"social_media_contribly_get_notifications_contributions_id_preview","summary":"GET /notifications/contributions/{id}/preview","description":"GET /notifications/contributions/{id}/preview","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the contribution to preview a notification for","schema":{"type":"string","description":"Id of the contribution to preview a notification for"}},{"name":"message","in":"query","required":true,"description":"Type of message to preview.","schema":{"type":"string","description":"Type of message to preview."}}],"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/social-media:contribly/get-scopes":{"get":{"operationId":"social_media_contribly_get_scopes","summary":"Scopes","description":"GET /scopes","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-subscription-types":{"get":{"operationId":"social_media_contribly_get_subscription_types","summary":"Subscription types","description":"GET /subscription-types","tags":["social-media"],"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"}},"/v1/social-media:contribly/get-subscriptions":{"get":{"operationId":"social_media_contribly_get_subscriptions","summary":"List subscriptions for the authorised user.","description":"GET /subscriptions","tags":["social-media"],"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"}},"/v1/social-media:contribly/delete-subscriptions-id":{"post":{"operationId":"social_media_contribly_delete_subscriptions_id","summary":"Delete a subscription.","description":"DELETE /subscriptions/{id}","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the subscription to delete"}}}}}},"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/social-media:contribly/get-tags":{"get":{"operationId":"social_media_contribly_get_tags","summary":"List tags","description":"GET /tags","tags":["social-media"],"parameters":[{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to those owned by this user.","schema":{"type":"string","description":"Restrict results to those owned by this user."}},{"name":"tagSet","in":"query","required":false,"description":"Restrict results to tags belonging to this tag set.","schema":{"type":"string","description":"Restrict results to tags belonging to this tag set."}},{"name":"urlWords","in":"query","required":false,"description":"Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tags.","schema":{"type":"string","description":"Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tags."}}],"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/social-media:contribly/post-tags":{"post":{"operationId":"social_media_contribly_post_tags","summary":"Create a new tag","description":"POST /tags","tags":["social-media"],"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/social-media:contribly/get-tags-id":{"get":{"operationId":"social_media_contribly_get_tags_id","summary":"Retrieve a single tag by id","description":"GET /tags/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the tag to return","schema":{"type":"string","description":"Id of the tag to return"}}],"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/social-media:contribly/get-tagsets":{"get":{"operationId":"social_media_contribly_get_tagsets","summary":"List tag sets","description":"GET /tagsets","tags":["social-media"],"parameters":[{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to those owned by this user.","schema":{"type":"string","description":"Restrict results to those owned by this user."}},{"name":"urlWords","in":"query","required":false,"description":"Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tag sets.","schema":{"type":"string","description":"Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tag sets."}}],"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/social-media:contribly/post-tagsets":{"post":{"operationId":"social_media_contribly_post_tagsets","summary":"Create a new tag set","description":"POST /tagsets","tags":["social-media"],"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/social-media:contribly/get-tagsets-id":{"get":{"operationId":"social_media_contribly_get_tagsets_id","summary":"Retrieve a single tag set by id","description":"GET /tagsets/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the tag set to return","schema":{"type":"string","description":"Id of the tag set to return"}}],"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/social-media:contribly/get-users":{"get":{"operationId":"social_media_contribly_get_users","summary":"List users","description":"GET /users","tags":["social-media"],"parameters":[{"name":"assignment","in":"query","required":false,"description":"Restrict results to the users who have contributed to this assignment.","schema":{"type":"string","description":"Restrict results to the users who have contributed to this assignment."}},{"name":"country","in":"query","required":false,"description":"Restrict results to the users who have submitted a contribution with a public location located within this country.","schema":{"type":"string","description":"Restrict results to the users who have submitted a contribution with a public location located within this country."}},{"name":"minimumContributions","in":"query","required":false,"description":"Restrict results to the users who have submitted at least this many contributions.","schema":{"type":"number","description":"Restrict results to the users who have submitted at least this many contributions."}},{"name":"linkedProfile","in":"query","required":false,"description":"Restrict results to the users who a linked profile of this type.","schema":{"type":"string","description":"Restrict results to the users who a linked profile of this type."}},{"name":"ownedBy","in":"query","required":false,"description":"Restrict results to the users who are owned by of this owner.","schema":{"type":"string","description":"Restrict results to the users who are owned by of this owner."}},{"name":"submittedBefore","in":"query","required":false,"description":"Limit results to users who have submitted at least one contribution before this date time.","schema":{"type":"string","description":"Limit results to users who have submitted at least one contribution before this date time."}},{"name":"submittedAfter","in":"query","required":false,"description":"Limit results to users who have submitted at least one contribution after this date time.","schema":{"type":"string","description":"Limit results to users who have submitted at least one contribution after this date time."}},{"name":"username","in":"query","required":false,"description":"Restrict results to the user with this username.","schema":{"type":"string","description":"Restrict results to the user with this username."}}],"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/social-media:contribly/get-users-id":{"get":{"operationId":"social_media_contribly_get_users_id","summary":"Retrieve a single user by id","description":"GET /users/{id}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the user to return","schema":{"type":"string","description":"Id of the user to return"}}],"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/social-media:contribly/get-users-id-linked-type":{"get":{"operationId":"social_media_contribly_get_users_id_linked_type","summary":"Retrieve a users linked profile by type","description":"GET /users/{id}/linked/{type}","tags":["social-media"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the user to return","schema":{"type":"string","description":"Id of the user to return"}},{"name":"type","in":"query","required":true,"description":"Type of the linked profile to fetch","schema":{"type":"string","description":"Type of the linked profile to fetch"}}],"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/social-media:contribly/post-verify":{"post":{"operationId":"social_media_contribly_post_verify","summary":"Verify token and return details of the owning user","description":"POST /verify","tags":["social-media"],"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"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"}}}}}}}