Skip to content
WaalaxyWaalaxy AI API

Get analytics

GET
/v1/cockpit/analytics
curl --request GET \
  --url 'https://developers.waalaxy.ai/v1/cockpit/analytics?range=7' \
  --header 'Authorization: Bearer <token>'

Get the performance indicators and the funnel, by period, agent or LinkedIn account

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
range
string
default: 7
Allowed values: 7 30 90 today

GET /v1/cockpit/analytics Parameter

agentId
string
>= 1 characters

GET /v1/cockpit/analytics Parameter

linkedinAccountId
string
>= 1 characters

GET /v1/cockpit/analytics Parameter

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required
object
range
required
string
Allowed values: 7 30 90 today
from
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
to
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
kpis
required
object
messagesSent
required
object
value
required
integer
<= 9007199254740991
deltaValue
required
integer | null
>= -9007199254740991 <= 9007199254740991
deltaPercent
required
integer | null
>= -9007199254740991 <= 9007199254740991
series
required
Array<integer>
replies
required
object
value
required
integer
<= 9007199254740991
deltaValue
required
integer | null
>= -9007199254740991 <= 9007199254740991
deltaPercent
required
integer | null
>= -9007199254740991 <= 9007199254740991
series
required
Array<integer>
interested
required
object
value
required
integer
<= 9007199254740991
deltaValue
required
integer | null
>= -9007199254740991 <= 9007199254740991
deltaPercent
required
integer | null
>= -9007199254740991 <= 9007199254740991
series
required
Array<integer>
linkClicks
required
object
value
required
integer
<= 9007199254740991
deltaValue
required
integer | null
>= -9007199254740991 <= 9007199254740991
deltaPercent
required
integer | null
>= -9007199254740991 <= 9007199254740991
series
required
Array<integer>
funnel
required
object
entryLeads
required
integer
<= 9007199254740991
sourcedInPeriod
required
integer
<= 9007199254740991
notContacted
required
integer
<= 9007199254740991
inviteSent
required
integer
<= 9007199254740991
alreadyConnected
required
integer
<= 9007199254740991
messagedViaNew
required
integer
<= 9007199254740991
replied
required
integer
<= 9007199254740991
interested
required
integer
<= 9007199254740991
notInterested
required
integer
<= 9007199254740991
Example
{
  "status": "success",
  "data": {
    "range": "7"
  }
}

400

Section titled “400”

Error, see Errors and rate limits

Media typeapplication/json
object
status
required
string
Allowed value: error
error
required
object
message
required
string
code
string
requestId
string
Example
{
  "status": "error"
}