Pickle

Docs

Pickle is very easy to use.

API

Base url
https://pickle.sh/api

Authentication

Go to the API keys page in your workspace and grab a key. Pass it in the x-pickle-key header in your request.

Examples

These examples are written in TypeScript and use axios.

Identifying users

Url
/identify
await axios.request({
  headers: {
    'x-pickle-key': 'YOUR_PICKLE_KEY'
  },
  data: {
    id: 'userId',
    anonymousId: 'anonymousUserId',
    data: {},
    meta: {}
  },
  method: 'post',
  url: 'https://pickle.sh/api/identify'
})

Sending events

Url
/events
await axios.request({
  headers: {
    'x-pickle-key': 'YOUR_PICKLE_KEY'
  },
  data: {
    name: 'eventName',
    userId: 'userId',
    data: {},
    meta: {}
  },
  method: 'post',
  url: 'https://pickle.sh/api/events'
})

Recording views

Url
/views
await axios.request({
  headers: {
    'x-pickle-key': 'YOUR_PICKLE_KEY'
  },
  data: {
    name: 'viewName',
    userId: 'userId',
    data: {},
    meta: {}
  },
  method: 'post',
  url: 'https://pickle.sh/api/views'
})

Libraries

Official

Limits

  • The maximum payload size for each request is 2KB