Events

curl -X POST https://api-catalog.nucleoplatform.com/api/collect/v1/events \
  -H "X-Nucleo-Key: $NUCLEO_COLLECTOR_KEY" \
  -H 'Origin: https://shop.acme.example' \
  -H 'Content-Type: text/plain' \
  -d '{
  "v": 1,
  "visitor": {
    "id": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
    "consent": "granted",
    "purposes": [
      "analytics",
      "personalisation"
    ],
    "consentSource": "shopify",
    "locale": "it",
    "channel": "web"
  },
  "session": "s_4c2a9e1b7f3d5a60",
  "customer": "v1.12.7012345678.1791104400.9c1e4b7a2f0d3c6e8b5a1f4d7c0e3b6a9d2f5c8e1b4a7d0c3f6e9b2a5d8c1f4e",
  "events": [
    {
      "uid": "e-7f3a9c1b20",
      "kind": "page_view",
      "market": "IT",
      "payload": {
        "type": "collection",
        "path": "/collections/men",
        "collection": "men",
        "filters": "filter.v.option.color=Black;filter.v.price.lte=80",
        "sort": "price-ascending"
      }
    },
    {
      "uid": "e-7f3a9c1b21",
      "kind": "product_view",
      "ref": {
        "product": "8123456789",
        "variant": "44001234567",
        "handle": "classic-tee-black",
        "sku": "TEE-BLK-M"
      },
      "payload": {
        "price": "29.00",
        "currency": "EUR",
        "pos": 3,
        "list": "collection:men",
        "from": "/collections/men"
      }
    },
    {
      "uid": "e-7f3a9c1b22",
      "kind": "search",
      "query": "black hoodie",
      "payload": {
        "results": 12
      }
    },
    {
      "uid": "e-7f3a9c1b23",
      "kind": "add_to_cart",
      "ref": {
        "variant": "44001234567",
        "sku": "TEE-BLK-M"
      },
      "payload": {
        "cart": "c1-9f2b7e4a1d",
        "quantity": 1,
        "price": "29.00",
        "currency": "EUR"
      }
    }
  ]
}'

const res = await fetch("https://api-catalog.nucleoplatform.com/api/collect/v1/events", {
  method: "POST",
  headers: {
    "X-Nucleo-Key": `${process.env.NUCLEO_COLLECTOR_KEY}`,
    Origin: "https://shop.acme.example",
    "Content-Type": "text/plain",
  },
  body: JSON.stringify({
    "v": 1,
    "visitor": {
      "id": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
      "consent": "granted",
      "purposes": [
        "analytics",
        "personalisation"
      ],
      "consentSource": "shopify",
      "locale": "it",
      "channel": "web"
    },
    "session": "s_4c2a9e1b7f3d5a60",
    "customer": "v1.12.7012345678.1791104400.9c1e4b7a2f0d3c6e8b5a1f4d7c0e3b6a9d2f5c8e1b4a7d0c3f6e9b2a5d8c1f4e",
    "events": [
      {
        "uid": "e-7f3a9c1b20",
        "kind": "page_view",
        "market": "IT",
        "payload": {
          "type": "collection",
          "path": "/collections/men",
          "collection": "men",
          "filters": "filter.v.option.color=Black;filter.v.price.lte=80",
          "sort": "price-ascending"
        }
      },
      {
        "uid": "e-7f3a9c1b21",
        "kind": "product_view",
        "ref": {
          "product": "8123456789",
          "variant": "44001234567",
          "handle": "classic-tee-black",
          "sku": "TEE-BLK-M"
        },
        "payload": {
          "price": "29.00",
          "currency": "EUR",
          "pos": 3,
          "list": "collection:men",
          "from": "/collections/men"
        }
      },
      {
        "uid": "e-7f3a9c1b22",
        "kind": "search",
        "query": "black hoodie",
        "payload": {
          "results": 12
        }
      },
      {
        "uid": "e-7f3a9c1b23",
        "kind": "add_to_cart",
        "ref": {
          "variant": "44001234567",
          "sku": "TEE-BLK-M"
        },
        "payload": {
          "cart": "c1-9f2b7e4a1d",
          "quantity": 1,
          "price": "29.00",
          "currency": "EUR"
        }
      }
    ]
  }),
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-catalog.nucleoplatform.com/api/collect/v1/events', [
    'headers' => [
        'X-Nucleo-Key' => getenv('NUCLEO_COLLECTOR_KEY'),
        'Origin' => 'https://shop.acme.example',
        'Content-Type' => 'text/plain',
    ],
    'json' => [
        'v' => 1,
        'visitor' => [
            'id' => '8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f',
            'consent' => 'granted',
            'purposes' => [
                'analytics',
                'personalisation',
            ],
            'consentSource' => 'shopify',
            'locale' => 'it',
            'channel' => 'web',
        ],
        'session' => 's_4c2a9e1b7f3d5a60',
        'customer' => 'v1.12.7012345678.1791104400.9c1e4b7a2f0d3c6e8b5a1f4d7c0e3b6a9d2f5c8e1b4a7d0c3f6e9b2a5d8c1f4e',
        'events' => [
            [
                'uid' => 'e-7f3a9c1b20',
                'kind' => 'page_view',
                'market' => 'IT',
                'payload' => [
                    'type' => 'collection',
                    'path' => '/collections/men',
                    'collection' => 'men',
                    'filters' => 'filter.v.option.color=Black;filter.v.price.lte=80',
                    'sort' => 'price-ascending',
                ],
            ],
            [
                'uid' => 'e-7f3a9c1b21',
                'kind' => 'product_view',
                'ref' => [
                    'product' => '8123456789',
                    'variant' => '44001234567',
                    'handle' => 'classic-tee-black',
                    'sku' => 'TEE-BLK-M',
                ],
                'payload' => [
                    'price' => '29.00',
                    'currency' => 'EUR',
                    'pos' => 3,
                    'list' => 'collection:men',
                    'from' => '/collections/men',
                ],
            ],
            [
                'uid' => 'e-7f3a9c1b22',
                'kind' => 'search',
                'query' => 'black hoodie',
                'payload' => [
                    'results' => 12,
                ],
            ],
            [
                'uid' => 'e-7f3a9c1b23',
                'kind' => 'add_to_cart',
                'ref' => [
                    'variant' => '44001234567',
                    'sku' => 'TEE-BLK-M',
                ],
                'payload' => [
                    'cart' => 'c1-9f2b7e4a1d',
                    'quantity' => 1,
                    'price' => '29.00',
                    'currency' => 'EUR',
                ],
            ],
        ],
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

{
  "accepted": 4,
  "stored": 3,
  "duplicates": 1,
  "rejected": [
    {
      "index": 4,
      "reason": "kind"
    }
  ],
  "payloadDropped": [
    1
  ],
  "withheld": [],
  "skew": 0,
  "unmapped": 0,
  "cartRefused": 0,
  "identified": true,
  "identityWithheld": false,
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f"
}

{
  "accepted": 3,
  "stored": 0,
  "reason": "consent",
  "rejected": [],
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f"
}

{
  "accepted": 1,
  "stored": 0,
  "duplicates": 0,
  "rejected": [],
  "payloadDropped": [],
  "withheld": [],
  "skew": 0,
  "unmapped": 0,
  "cartRefused": 0,
  "identified": false,
  "identityWithheld": false,
  "visitor": "4e6c1a9b2d7f3e5a8c0b1d2e3f4a5b6c",
  "test": true,
  "testKnown": true
}

{
  "accepted": 2,
  "stored": 0,
  "rejected": [
    {
      "index": 0,
      "reason": "storage"
    },
    {
      "index": 1,
      "reason": "storage"
    }
  ],
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f"
}

{
  "message": "Forbidden."
}

{
  "message": "Not found."
}

{
  "message": "Store is not ready."
}

{
  "message": "Payload too large."
}

{
  "message": "The batch is not valid.",
  "errors": {
    "visitor.id": "visitor.id is required: 16-64 characters of [A-Za-z0-9_-]."
  }
}

{
  "message": "The batch is not valid.",
  "errors": {
    "events": "A batch holds at most 50 events."
  }
}

{
  "message": "The batch is not valid.",
  "errors": {
    "visitor.consent": "visitor.consent must be one of: granted, denied, pending, revoked.",
    "test": "test must be a 6-character code of [A-Z0-9]."
  }
}

{
  "message": "The batch is not valid.",
  "errors": {
    "visitor.id": "visitor.id must not start with \"demo\": the prefix is reserved for the simulated signal."
  }
}

{
  "message": "The batch is not valid.",
  "errors": {
    "v": "Unsupported batch version: only v=1 is accepted."
  }
}

{
  "message": "Too Many Attempts."
}