Pixels (Facebook, TikTok, etc.)

Get my pixels

Get all pixels of current user.

get/api/v1/pixel

Query parameters

order_by'created_at' | 'updated_at'

Field to order by

order_direction'asc' | 'desc'

Order direction: 'asc' or 'desc'

filter_by_type'tiktok' | 'facebook' | 'google' | 'twitter'

Filter by: PixelType

filterByCompanyUserIdstring[] nullable

Filter by company user ID(s)

Filter by company user ID(s)

all_availableboolean

Whether to get all PWAs (including those of other users in the same company, if permissions allow) or only the user's own PWAs

Whether to get all PWAs (including those of other users in the same company, if permissions allow) or only the user's own PWAs

pageinteger
sizeinteger

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Example response

{
  "items": [
    {
      "comment": "This is an example comment. All data, including pixel ID and EAAG, is a sample",
      "createdAt": "2022-01-01T00:00:00",
      "id": "123e4567-e89-b12-d3a456426614",
      "owner": {
        "email": "example@.com",
        "logo_url": "https://example.com/owner_logo.png",
        "owner_company_user_id": "d290f1ee-6c54-4fbb-9fa6-0e02b2c3d479"
      },
      "pixel": "32643637483211",
      "pixel_type": "facebook",
      "token": "EAAGm0PX4ZBEBAGqZC1ZC8Jg1ZBZA0nE8Kv1gE0VZBZB8ZBnbZC2qZC5RXX1rZB5eAZDZD",
      "updatedAt": "2022-01-01T00:00:00"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.