List project events

GET

platform

projects

{projectId}

events

List project events

curl --request GET \
  --url https://api.polymorfa.com/platform/projects/{projectId}/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/projects/{projectId}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "source": "runtime",
      "environment": "development",
      "createdAt": "2023-11-07T05:31:56Z",
      "payloadAvailability": "available",
      "payload": {
        "encoding": "base64",
        "contentType": "application/json",
        "data": "aSDinaTvuI8gbWludGxpZnk="
      },
      "replayableUntil": "2023-11-07T05:31:56Z",
      "metadataExpiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true,
    "nextOffset": "<string>",
    "highWatermark": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Path Parameters

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Query Parameters

type

string

Type discriminator for this object.

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

cursor

string

Specifies cursor for this query parameter.

afterOffset

string

Return events indexed after this retained-stream offset, in ingestion order. Cannot be combined with cursor, since, or until. Pass 0 to obtain page.highWatermark for an initial wait baseline.

Value constraints

Constraint	Accepted input
Pattern	`^(0\|[1-9][0-9]*)$`

Pattern: ^(0|[1-9][0-9]*)$

Response

Success

data

object[]

required

Structured data carried by this object.

Show child attributes

page

object

required

Specifies page for this schema.

Show child attributes

List project events

curl --request GET \
  --url https://api.polymorfa.com/platform/projects/{projectId}/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/projects/{projectId}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "source": "runtime",
      "environment": "development",
      "createdAt": "2023-11-07T05:31:56Z",
      "payloadAvailability": "available",
      "payload": {
        "encoding": "base64",
        "contentType": "application/json",
        "data": "aSDinaTvuI8gbWludGxpZnk="
      },
      "replayableUntil": "2023-11-07T05:31:56Z",
      "metadataExpiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true,
    "nextOffset": "<string>",
    "highWatermark": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

List project events

Authorizations

Path Parameters

Query Parameters

Response