Easyflow API Document
This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.
https://docs.easyflow.digital/_mock/openapi/
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/
This route allows you to create a tracking pixel linked to your account, with support for Google and Meta platforms. After creation, the pixel must be integrated into your website or application using our official SDK to ensure proper event sending and tracking.
👉 Access the SDK and usage instructions: SDK
An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:
checkout-initialized
purchase-completed
purchase-failed
purchase-btn-clicked
pix-selected
pix-generated
pix-expired
pix-copied
credit-card-selected
credit-card-form-completed
bank-slip-selected
bank-slip-form-completed
address-form-completed
delivery-address-completed
coupon-added
coupon-box-clicked
coupon-form-completed
coupon-apply-failed
user-form-completed
https://docs.easyflow.digital/_mock/openapi/pixels
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels
curl -i -X POST \
https://docs.easyflow.digital/_mock/openapi/pixels \
-H 'Content-Type: application/json' \
-H 'x-api-key: string' \
-H 'x-api-secret: string' \
-d '{
"name": "string",
"description": "string",
"ownerId": "string",
"externalReferenceId": "string",
"platform": "string",
"code": "string",
"events": [
"string"
],
"metadata": {
"conversion-label": "string"
}
}'{ "statusCode": 0, "data": { "pixel": { … } } }
An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:
checkout-initialized
purchase-completed
purchase-failed
purchase-btn-clicked
pix-selected
pix-generated
pix-expired
pix-copied
credit-card-selected
credit-card-form-completed
bank-slip-selected
bank-slip-form-completed
address-form-completed
delivery-address-completed
coupon-added
coupon-box-clicked
coupon-form-completed
coupon-apply-failed
user-form-completed
https://docs.easyflow.digital/_mock/openapi/pixels/{pixelId}
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/{pixelId}
curl -i -X PATCH \
'https://docs.easyflow.digital/_mock/openapi/pixels/{pixelId}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: string' \
-H 'x-api-secret: string' \
-d '{
"name": "string",
"description": "string",
"platform": "string",
"status": "string",
"code": "string",
"events": [
"string"
]
}'{ "statusCode": 0, "data": { "updated": true } }
https://docs.easyflow.digital/_mock/openapi/pixels/list
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/list
curl -i -X GET \
'https://docs.easyflow.digital/_mock/openapi/pixels/list?filter%5Bcode%5D=string&filter%5BexternalReferenceId%5D=string&filter%5BownerId%5D=string&filter%5Bplatform%5D=string&limit=string&page=string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'{ "statusCode": 0, "data": { "pixels": { … } } }
https://docs.easyflow.digital/_mock/openapi/pixels/details/{pixelId}
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/details/{pixelId}
curl -i -X GET \
'https://docs.easyflow.digital/_mock/openapi/pixels/details/{pixelId}' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'{ "statusCode": 0, "data": { "pixel": { … } } }
https://docs.easyflow.digital/_mock/openapi/pixels/delete/{pixelId}
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/delete/{pixelId}
curl -i -X DELETE \
'https://docs.easyflow.digital/_mock/openapi/pixels/delete/{pixelId}' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'{ "statusCode": 0, "data": { "deleted": true } }