POST
/
api
/
public
/
apps
/
screen
curl --request POST \
  --url http://localhost:3001/api/public/apps/screen \
  --header 'Content-Type: application/json' \
  --header 'PublicWriteKey: <api-key>' \
  --header 'authorization: <authorization>' \
  --data '{
  "messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
  "timestamp": "2024-04-22T07:00:00.000Z",
  "context": {
    "ip": "192.0.2.1"
  },
  "name": "Home",
  "properties": {
    "title": "My Screen"
  },
  "userId": "1043"
}'
"<string>"

The following is an example of a screen body.

example body
{
  "name": "Home",
  "userId": "1043",
  "properties": {
    "Feed Type": "private"
  },
  "messageId": "1ff51c9c-4929-45de-8914-3bb878be8c4a"
}

Authorizations

​
PublicWriteKey
string
header
required

Authorization header for the request, in the format Bearer <token>. Find your token at https://app.dittofeed.com/dashboard/settings#write-key.

Headers

​
authorization
string
required

Authorization header for the request, in the format Bearer <token>. Find your token at https://app.dittofeed.com/dashboard/settings#write-key.

Body

application/json
​
messageId
string
required

Unique identifier for the message, used as an idempotency key for safe retries. Can provide a UUID.

Example:

"23d04926-78e5-4ebc-853f-f26c84ff629e"

​
userId
string
required

Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.

Example:

"1043"

​
timestamp
string

ISO 8601 formatted timestamp of when the event occurred. If not provided, the current server time will be used.

Example:

"2024-04-22T07:00:00.000Z"

​
context
object

Provides metadata about the user submitting the event and the context in which the event occurred.

Example:
{ "ip": "192.0.2.1" }
​
name
string

Name of the screen visited by the user.

Example:

"Home"

​
properties
object

Free-form dictionary of properties of the screen, like title.

Example:
{ "title": "My Screen" }

Response

204
application/json

An empty String