Skip to main content
POST
/
api
/
public
/
apps
/
screen
cURL
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": "<string>",
  "userId": "<string>",
  "timestamp": "<string>",
  "context": {},
  "name": "<string>",
  "properties": {}
}
'
import requests

url = "http://localhost:3001/api/public/apps/screen"

payload = {
    "messageId": "<string>",
    "userId": "<string>",
    "timestamp": "<string>",
    "context": {},
    "name": "<string>",
    "properties": {}
}
headers = {
    "authorization": "<authorization>",
    "PublicWriteKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    authorization: '<authorization>',
    PublicWriteKey: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    messageId: '<string>',
    userId: '<string>',
    timestamp: '<string>',
    context: {},
    name: '<string>',
    properties: {}
  })
};

fetch('http://localhost:3001/api/public/apps/screen', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/public/apps/screen",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messageId' => '<string>',
    'userId' => '<string>',
    'timestamp' => '<string>',
    'context' => [
        
    ],
    'name' => '<string>',
    'properties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PublicWriteKey: <api-key>",
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "http://localhost:3001/api/public/apps/screen"

	payload := strings.NewReader("{\n  \"messageId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"timestamp\": \"<string>\",\n  \"context\": {},\n  \"name\": \"<string>\",\n  \"properties\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("PublicWriteKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:3001/api/public/apps/screen")
  .header("authorization", "<authorization>")
  .header("PublicWriteKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messageId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"timestamp\": \"<string>\",\n  \"context\": {},\n  \"name\": \"<string>\",\n  \"properties\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/public/apps/screen")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["PublicWriteKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messageId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"timestamp\": \"<string>\",\n  \"context\": {},\n  \"name\": \"<string>\",\n  \"properties\": {}\n}"

response = http.request(request)
puts response.read_body
"<string>"
{
  "message": "<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.

Examples:

"1043"

"user-123"

"0a58e5e4-c753-477e-a6c4-f9b0e3396b9b"

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

An empty String

An empty String