EasyflowEasyflowDocs

Create pixel

POST/pixels

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

Headers

  • x-api-keystringrequired

    Api key provided on integrations tab in Easyflow platform.

  • x-api-secretstringrequired

    Api Secret provided on integrations tab in Easyflow platform.

Request body

Content typeapplication/jsonobject

  • namestringrequired
  • descriptionstring
  • ownerIdstringrequired
  • externalReferenceIdstringrequired
  • platformstringrequired

    Possible values:googlemetatiktokgtm

  • codestringrequired
  • eventsarray of stringsrequired

    Events that the pixel tracks. The list cannot be empty.

    Possible values:checkout-initializedpurchase-completedpurchase-failedpurchase-btn-clickedpix-selectedpix-generatedpix-expiredpix-copiedcredit-card-form-initcredit-card-selectedcredit-card-form-completedbank-slip-selectedbank-slip-form-completedaddress-form-completeddelivery-address-completedcoupon-addedcoupon-box-clickedcoupon-form-initcoupon-form-completedcoupon-apply-faileduser-form-inituser-form-completedpre-checkout-form-initpre-checkout-form-completed

  • metadataobject

    Required when platform is google.

    Show child attributesHide child attributes
    • conversion-labelstring

      Conversion label. Required when platform is google.

  • serverSideMetadataobject

    Server-side settings. Only these keys are accepted.

    Show child attributesHide child attributes
    • capi-access-tokenstring

      Access token of the Meta Conversions API. When it is sent, enable-capi-access-token is set to true.

    • enable-capi-access-tokenboolean

Responses

200pixel creation was successful

pixel creation was successful

Content typeapplication/jsonobject

  • statusCodeinteger
  • dataobject
    Show child attributesHide child attributes
    • pixelobject
      Show child attributesHide child attributes
      • eventsarray of strings

        Possible values:checkout-initializedpurchase-completedpurchase-failedpurchase-btn-clickedpix-selectedpix-generatedpix-expiredpix-copiedcredit-card-form-initcredit-card-selectedcredit-card-form-completedbank-slip-selectedbank-slip-form-completedaddress-form-completeddelivery-address-completedcoupon-addedcoupon-box-clickedcoupon-form-initcoupon-form-completedcoupon-apply-faileduser-form-inituser-form-completedpre-checkout-form-initpre-checkout-form-completed

      • idstring
      • createdAtstring
      • updatedAtstring
      • ownerIdstring
      • externalReferenceIdstring
      • platformstring

        Possible values:googlemetatiktokgtm

      • statusstring

        Possible values:activeinactive

      • codestring
      • namestring
      • descriptionstring
      • serverSideMetadataobject
        Show child attributesHide child attributes
        • capi-access-tokenstring
        • enable-capi-access-tokenboolean
      • metadataobject
        Show child attributesHide child attributes
        • conversion-labelstring
400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Invalid param: []

    Example:Invalid param: []

  • errorstring

    Bad Request

    Example:Bad Request

  • statusCodeinteger

    400

    Example:400

  • errorCodestring

    Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Invalid field

    Example:Unauthorized

  • errorstring

    Unauthorized

    Example:Unauthorized

  • statusCodeinteger

    401

    Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Forbidden resource

    Example:Forbidden resource

  • errorstring

    Forbidden

    Example:Forbidden

  • statusCodeinteger

    403

    Example:403

409A pixel with the same ownerId, externalReferenceId, code and platform already exists. For google the conversion label is also compared, and for meta with a Conversions API token the token is also compared.

A pixel with the same ownerId, externalReferenceId, code and platform already exists. For google the conversion label is also compared, and for meta with a Conversions API token the token is also compared.

Content typeapplication/jsonobject

  • statusCodeintegerrequired

    HTTP status code.

  • messagestringrequired

    Explanation of the error.

  • errorstring

    Name of the HTTP status, such as Bad Request or Conflict.

  • errorCodestring

    Code that identifies the error. Present only on some errors.

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

  • statusCodeinteger

    HTTP status code.

    Example:500

  • messagestring

    Explanation of the error.

    Example:Internal Server Error