{"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/communication:sendgrid-email-activity-v3/list-message":{"get":{"operationId":"communication_sendgrid_email_activity_v3_list_message","summary":"Filter all messages","description":"GET /v3/messages","tags":["communication"],"parameters":[{"name":"query","in":"query","required":true,"description":"Use the query syntax to filter your email activity. Combine up to 160 filter conditions per request.","schema":{"type":"string","description":"Use the query syntax to filter your email activity. Combine up to 160 filter conditions per request."}},{"name":"limit","in":"query","required":false,"description":"The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000","schema":{"type":"number","default":10,"description":"The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000"}}],"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/communication:sendgrid-email-activity-v3/get-message":{"get":{"operationId":"communication_sendgrid_email_activity_v3_get_message","summary":"Filter messages by message ID","description":"GET /v3/messages/{msg_id}","tags":["communication"],"parameters":[{"name":"msg_id","in":"query","required":true,"description":"The ID of the message you are requesting details for.","schema":{"type":"string","description":"The ID of the message you are requesting details for."}}],"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/communication:sendgrid-email-activity-v3/request-csv":{"post":{"operationId":"communication_sendgrid_email_activity_v3_request_csv","summary":"Request CSV","description":"POST /v3/messages/download","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","description":"Uses a SQL like syntax to indicate which messages to include in the CSV"}}}}}},"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/communication:sendgrid-email-activity-v3/download-csv":{"get":{"operationId":"communication_sendgrid_email_activity_v3_download_csv","summary":"Download CSV","description":"GET /v3/messages/download/{download_uuid}","tags":["communication"],"parameters":[{"name":"download_uuid","in":"query","required":true,"description":"UUID used to locate the download csv request entry in the DB. This is the UUID provided in the email sent to the user when their csv file…","schema":{"type":"string","description":"UUID used to locate the download csv request entry in the DB. This is the UUID provided in the email sent to the user when their csv file…"}}],"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"}}}}}}}