Get pixel

GET/pixels/details/{pixelId}

returns the details of a pixel

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/details/PIXEL_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/details/PIXEL_ID', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/details/PIXEL_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "pixel": {
      "id": "6650f1a2b3c4d5e6f7a8b9c1",
      "ownerId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
      "externalReferenceId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
      "platform": "meta",
      "status": "active",
      "code": "123456789012345",
      "events": [
        "checkout-initialized",
        "purchase-completed"
      ],
      "createdAt": "2026-01-15T12:00:00.000Z",
      "updatedAt": "2026-01-15T12:00:00.000Z",
      "name": "Meta pixel",
      "description": "Tracks checkout conversions",
      "metadata": {},
      "serverSideMetadata": {
        "capi-access-token": "********",
        "enable-capi-access-token": true
      }
    }
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

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.

Path parameters

pixelIdstringrequired

Responses

200returns the details of a pixel

returns the details of a pixel

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- pixelobject
  Show child attributesHide child attributes
  idstring
  ownerIdstring
  externalReferenceIdstring
  platformstring
  Platform of the pixel. A pixel created by Easyflow can bring a value outside this list, so accept unknown values.
  
  Possible values:googlemetatiktokgtm
  statusstring
  Possible values:activeinactive
  codestring
  eventsarray of strings
  Events tracked by the pixel. A pixel created by Easyflow can bring events outside this list, so accept unknown values.
  
  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
  createdAtstring
  updatedAtstring
  namestring
  descriptionstring
  metadataobject
  Show child attributesHide child attributes
  conversion-labelstring
  serverSideMetadataobject
  Show child attributesHide child attributes
  capi-access-tokenstring
  Always masked as ******** when a token is stored. The token itself is never returned.
  
  enable-capi-access-tokenboolean

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

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