Skip to main content
POST
/
bc
/
v1
/
events
/
event
/
start-session
Start a session
curl --request POST \
  --url https://app.mindlytics.ai/bc/v1/events/event/start-session \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-ID: <api-key>' \
  --data '
{
  "session_id": "<string>",
  "type": "start_session",
  "timestamp": "<string>",
  "user_id": "<string>",
  "device_id": "<string>",
  "id": "<string>",
  "attributes": {}
}
'
import requests

url = "https://app.mindlytics.ai/bc/v1/events/event/start-session"

payload = {
    "session_id": "<string>",
    "type": "start_session",
    "timestamp": "<string>",
    "user_id": "<string>",
    "device_id": "<string>",
    "id": "<string>",
    "attributes": {}
}
headers = {
    "Authorization": "<api-key>",
    "X-App-ID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'X-App-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    session_id: '<string>',
    type: 'start_session',
    timestamp: '<string>',
    user_id: '<string>',
    device_id: '<string>',
    id: '<string>',
    attributes: {}
  })
};

fetch('https://app.mindlytics.ai/bc/v1/events/event/start-session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mindlytics.ai/bc/v1/events/event/start-session",
  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([
    'session_id' => '<string>',
    'type' => 'start_session',
    'timestamp' => '<string>',
    'user_id' => '<string>',
    'device_id' => '<string>',
    'id' => '<string>',
    'attributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "X-App-ID: <api-key>"
  ],
]);

$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 := "https://app.mindlytics.ai/bc/v1/events/event/start-session"

	payload := strings.NewReader("{\n  \"session_id\": \"<string>\",\n  \"type\": \"start_session\",\n  \"timestamp\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"device_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"attributes\": {}\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("X-App-ID", "<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("https://app.mindlytics.ai/bc/v1/events/event/start-session")
  .header("Authorization", "<api-key>")
  .header("X-App-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"session_id\": \"<string>\",\n  \"type\": \"start_session\",\n  \"timestamp\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"device_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"attributes\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.mindlytics.ai/bc/v1/events/event/start-session")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["X-App-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"session_id\": \"<string>\",\n  \"type\": \"start_session\",\n  \"timestamp\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"device_id\": \"<string>\",\n  \"id\": \"<string>\",\n  \"attributes\": {}\n}"

response = http.request(request)
puts response.read_body
[
  {}
]

Authorizations

Authorization
string
header
required

API Key for your organization

X-App-ID
string
header
required

Project ID

Body

application/json
session_id
string
required

A unique session ID generated by caller

type
enum<string>
required

The event that starts a session

Available options:
start_session
timestamp
string

The timestamp of the event, defaults to "now" if not specified.

user_id
string

The unique ID of the user

device_id
string

The ID of the device, if applicable

id
string

The unique ID of the user

attributes
object

Any additional attributes to be associated with the session

Response

200 - application/json

Success

type
enum<string>
required

The type of event being sent.

Available options:
start_session,
end_session,
identify,
alias,
track
{key}