Session Stores

/session/update

Upsert and/or delete data stored in a specified session store.

POST/session/update

Base URLAuthorization Token

store *

ops *

curl

curl https://test-m1.minusonedb.com/session/update -d 'store=stash&ops=[{"upsert":[
{
    "ip": "65.29.29.190",
    "session": {
      "id": "0295aed9-5872-4586-8086-57d3d8c40fb8",
      "start": 1612497996184
    },
    "user": {
      "id": "f7661f25-7c49-4f3b-9185-ec6566892878"
    },
    "event": {
      "id": "6dd089ce-5a96-4fac-a405-43c1ab3eb6b3",
      "time": 1612497996000,
      "type": "heartbeat",
      "data": {
        "a": "timers",
        "b": "string",
        "foo": "epe",
        "bar": "string"
      }
    }
}]},
{"delete" : ["78ba3dac-3e45-4e17-940e-e66584882ce4"]}]' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/update -store stash -ops '[{"upsert": [{"ip": "65.29.29.190","session": {"id": "0295aed9-5872-4586-8086-57d3d8c40fb8","start": 1612497996184}}]},{"delete": ["78ba3dac-3e45-4e17-940e-e66584882ce4"]}]'

• rights: sessionUpdate
• verbs: POST

Parameter	Type	Required
store	String	Yes
ops	JSON (op[])	Yes

Each op may have two properties: upsert (map[], must have session id parameter set) and delete (Array, session ids to be deleted).

No response when successful.

/session/query

Retrieve matching records from a session store.

The syntax and semantics of /session/query are the same as /query where possible. Because session stores accept items that have a deeply nested structure, dotted notation is used to signify nesting. In the example below, the archived item contained an m1 key that was a map containing an ip key. To query against that property in /session/query, use m1.ip as the property name.

POST/session/query

Base URLAuthorization Token

store *

q *

sort

start

rows

curl

curl https://test-m1.minusonedb.com/session/query \
-d 'store=stash&q=_m1.ip:64.150.5.135' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/query -store stash -q "_m1.ip:64.150.5.135"

• rights: sessionQuery
• verbs: POST

Parameter	Type	Required
store	String	Yes
q	String	Yes
sort	String	No
start	long	No
rows	long	No

• returns: JSON map containing a count of items matching the query and the requested number of matching items

Note: This is a streaming endpoint.

▶200 OKReturns matching session records

{
  "count": 1,
  "items": [
    {
      "settings": {
        "doNotTrack": "boolean",
        "language": "string",
        "cookies": false
      },
      "_m1": {
        "receivedUTC": 1635539079099,
        "ip": "64.150.5.135"
      },
      "session": {
        "start": 1635538913819,
        "id": "0006184d-2961-497a-9203-38e39ed65976"
      },
      "screen": {
        "orientation": "landscape",
        "availableWidth": 3530,
        "availableHeight": 196,
        "width": 668,
        "height": 1775
      },
      "id": "0e168aaf-0af2-46f1-af91-65ca8a257752",
      "time": 1635539086000,
      "page": {
        "domain": "www.site.com",
        "timeOnPage": 100,
        "url": "string"
      },
      "window": {
        "width": 2000,
        "height": 3800
      },
      "event": {
        "type": "heartbeat"
      },
      "user": {
        "id": "b3c9f536-f3a8-4fd7-8c70-cd904de65443"
      }
    }
  ]
}

/session/list

Return a list of all configured session stores with metadata.

GET/session/list

Base URLAuthorization Token

curl

curl https://test-m1.minusonedb.com/session/list \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/list

• rights: get, admin
• verbs: GET
• parameters: none

▶200 OKReturns list of session stores

[
  {
    "shards": 1,
    "replicas": 1,
    "name": "stash",
    "key": "session.id"
  }
]

/session/key

Set the key to be used for identity tests.

POST/session/key

Base URLAuthorization Token

store *

key *

curl

curl https://test-m1.minusonedb.com/session/key \
-d "store=stash&key=session.id" \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/key -store stash -key "session.id"

• rights: admin
• verbs: POST

Parameter	Type	Required
store	String	Yes
key	String	Yes

No response when successful.

/session/add

Add configuration for a newly deployed session store. Called after a new store is deployed via MinusOneDB ops services. Use the m1 client to provision hardware and update your environment with one command.

POST/session/add

Base URLAuthorization Token

store *

key

shards *

replicas *

curl

curl https://test-m1.minusonedb.com/session/add \
-d "store=stash&key=session.id&shards=1&replicas=1" \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/add -store stash -key "session.id" -shards 1 -replicas 1

• rights: admin
• verbs: POST

Parameter	Type	Required
store	String	Yes
key	String	No
shards	long	Yes
replicas	long	Yes

The key defaults to session.id.

No response when successful.

/session/rename

Change the name of a session store.

POST/session/rename

Base URLAuthorization Token

store *

name *

curl

curl https://test-m1.minusonedb.com/session/rename \
-d "store=stash&name=newSessionStoreName" \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/rename -store stash -name newSessionStoreName

• rights: admin
• verbs: POST

Parameter	Type	Required
store	String	Yes
name	String	Yes

No response when successful.

/session/drop

Removes configuration for a session store. Typically called after the store is destroyed via MinusOneDB ops services. Use the m1 client to decommission server resources and update your environment with one command.

POST/session/drop

Base URLAuthorization Token

store *

curl

curl https://test-m1.minusonedb.com/session/drop \
-d "store=stash" \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 session/drop -store stash

• rights: admin
• verbs: POST

Parameter	Type	Required
store	String	Yes

No response when successful.