Get Pixels By Account

Returns a cursor-paginated list of pixels associated with a given account. Includes retargeting, conversion, and smart pixels. Results can be filtered by advertiser or pixel type. Results are ordered: retargeting pixels first (sorted by id), then conversion pixels (sorted by id), then smart pixels (sorted by id).

Endpoint

GET

https://lifeapi.pulsepoint.com/RestApi/v2/account/{accountId}/pixels

Path Parameters

NameData TypeRequiredNotes
accountIdintegeryesThe account ID the pixel is associated with

Query Parameters

NameData TypeRequiredDefaultNotes
advertiser_idintegernoFilter results to a single advertiser ID
typeENUM stringnoFilter by pixel type. Valid values: retargeting, conversion, smart
limitintegerno50Maximum number of results per page (max: 100)
cursorstringnoOpaque pagination cursor. Pass the next_cursor value from a previous response to get the next page

Sample Request

GET https://lifeapi.pulsepoint.com/RestApi/v2/account/323455/pixels?advertiser_id=1234&type=retargeting&limit=50

Response Field List

NameData TypeNotes
successbooleanReturns true on a successful request
messagestringHuman-readable result message
requestIdstringUnique identifier for the request
dataobjectWrapper containing results and pagination
data.dataarray of objectsList of pixel objects
data.data.idintegerUnique identifier for the pixel
data.data.namestringName of the pixel
data.data.typestringPixel type. One of: retargeting, conversion, smart
data.data.activebooleanWhether the pixel is active
data.data.advertiser_idintegerAdvertiser ID associated with the pixel
data.data.account_idintegerAccount ID associated with the pixel
data.paginationobjectPagination metadata
data.pagination.limitintegerThe page size used for this response
data.pagination.totalintegerTotal number of pixels matching the query
data.pagination.has_morebooleanWhether additional pages of results exist
data.pagination.next_cursorstringOpaque cursor to pass as the cursor query parameter to retrieve the next page
data.pagination.next_cursor_urlstringFull URL for the next page of results

Sample Response

{
  "success": true,
  "message": "Operation completed successfully",
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "data": [
      {
        "id": 123456,
        "name": "Rachel Pixel",
        "type": "retargeting",
        "active": true,
        "advertiser_id": 1234,
        "account_id": 323455
      },
      {
        "id": 123457,
        "name": "Rachel Pixel 2",
        "type": "conversion",
        "active": true,
        "advertiser_id": 1234,
        "account_id": 323455
      }
    ],
    "pagination": {
      "limit": 50,
      "total": 127,
      "has_more": true,
      "next_cursor": "eyJpZCI6MTIzNDU3fQ==",
      "next_cursor_url": "/RestApi/v2/account/323455/pixels?cursor=eyJpZCI6MTIzNDU3fQ==&limit=50"
    }
  }
}

Errors

HTTP StatusErrorDescription
400Validation ErrorInvalid query parameters. type must be one of: retargeting, conversion, smart
401UnauthorizedInvalid or expired access token
403ForbiddenYou do not have permission to access this account, or the advertiser ID does not belong to this account
429Too Many RequestsRate limit exceeded
500Internal Server ErrorUnexpected server error