Skip to content

Fetch admin session

GET
/api/v1/admin_session/{admin_session_id}
admin_session_id
required

Success

object
actions
AdminSession_AvailableActions
object
create_api_token
boolean
generate_bearer_token
boolean
revoke
boolean
summary
AdminSession_Summary
object
account_id
Account_Id

A valid account ID

string
013xrzp12g3nqk8n6cyr5x0k8yb10h59
admin_user_id
AdminUser_Id

A valid admin user ID

string
013xrzp12g3nqk8n5mhhq3nyj6v5g94a
first_seen
One of:
InteractionDetails

A snapshot of the details of a particular device

object
at
Timestamp

Unix timestamp, seconds since midnight January 1, 1970 UTC

number
1234567890
remote_ip
One of:

IPv4 address in dotted-decimal notation

string format: ipv4
127.0.0.1
user_agent
UserAgent

User-Agent string

string
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36
id
AdminSession_Id

A valid admin session ID

string
013xrzp12g3nqk8n9evk5hd4zb9yy8xd
last_seen
One of:
InteractionDetails

A snapshot of the details of a particular device

object
at
Timestamp

Unix timestamp, seconds since midnight January 1, 1970 UTC

number
1234567890
remote_ip
One of:

IPv4 address in dotted-decimal notation

string format: ipv4
127.0.0.1
user_agent
UserAgent

User-Agent string

string
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36
session_type
string
Allowed values: browser api
browser
status
string
Allowed values: new active
new
title
string
type
string
Allowed values: admin_session
admin_session

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value
bad_request
message
string
status
string
Allowed values: error
error