POST /v1/analytics/sales/search
POST
/v1/analytics/sales/search
const url = 'https://seu-endereco-da-api/v1/analytics/sales/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"window":"current","period":"7","filter":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/analytics/sales/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "window": "current", "period": "7", "filter": {} }'Permissão que a Chave de acesso precisa: Relatórios de vendas (analytics:sales).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
window
string
period
string
filter
object
key
additional properties
any
Responses
Seção intitulada “Responses”Media typeapplication/json
object
period
required
string
kpis
required
object
openValue
required
number
wonValue
required
number
lostValue
required
number
createdCount
required
number
wonCount
required
number
lostCount
required
number
conversion
required
number
closeRate
required
Won over won plus lost in the period, null when nothing was closed
number
avgTicket
required
number
avgDaysToClose
required
number
staleCount
required
number
prev
required
object
wonValue
required
number
wonCount
required
number
createdCount
required
number
lostValue
required
number
conversion
required
number
funnel
required
Array<object>
object
stageId
required
string
label
required
string
count
required
number
value
required
number
wonOverTime
required
Array<object>
object
label
required
string
value
required
number
byOwner
required
Array<object>
object
userId
required
string
name
required
string
created
required
number
won
required
number
wonValue
required
number
byOrigin
required
Array<object>
object
originId
required
string
name
required
string
color
required
string
created
required
number
won
required
number
lost
required
number
wonValue
required
number
closeRate
required
Won over won plus lost in the period, null when nothing was closed
number
byChannel
required
Array<object>
object
channelId
required
Channel of the lead conversation, null when the deal has no conversation
string
name
required
string
provider
required
string
created
required
number
won
required
number
lost
required
number
wonValue
required
number
closeRate
required
Won over won plus lost in the period, null when nothing was closed
number
byProduct
required
Array<object>
object
productId
required
string
name
required
string
units
required
number
revenue
required
number
lossReasons
required
Array<object>
object
id
required
string
name
required
string
count
required
number
valueCents
required
number
winReasons
required
Array<object>
object
id
required
string
name
required
string
count
required
number
valueCents
required
number
lostByOwner
required
Array<object>
object
userId
required
string
name
required
string
lostCount
required
number
lostValueCents
required
number
lossRate
required
number
lostByStage
required
Array<object>
object
stageId
required
string
name
required
string
pipelineName
required
string
lostCount
required
number
lostValueCents
required
number
lossRate
required
number
avgDaysToLose
required
number
lostList
required
Array<object>
object
dealId
required
string
number
required
number
contactName
required
string
ownerName
required
string
reason
required
string
note
required
string
lostAt
required
string
valueCents
required
number
wonList
required
Array<object>
object
dealId
required
string
number
required
number
contactName
required
string
tags
required
Array<string>
products
required
Array<string>
pipelineName
required
string
reason
required
string
note
required
string
cycleDays
required
number
wonAt
required
string
valueCents
required
number
stagnation
required
Array<object>
object
stageId
required
string
name
required
string
colorKey
required
string
openCount
required
number
staleCount
required
number
avgDaysInStage
required
number
stageConversion
required
Array<object>
object
stageId
required
string
name
required
string
colorKey
required
string
reached
required
Deals created in the period that were in this stage at some point
number
advanced
required
Of those, how many were also in the next stage; null on the last stage
number
rate
required
Advanced over reached, in percent; null when nobody reached the stage or on the last stage
number
biggestDrop
required
boolean
staleByStage
required
Stale open deals per pipeline and stage, every pipeline; the rows add up to kpis.staleCount
Array<object>
object
pipelineId
required
string
pipelineName
required
string
stageId
required
string
stageName
required
string
staleCount
required
number
collaborators
required
Array<object>
object
userId
required
string
name
required
string
avatarUrl
required
string
wonCount
required
number
wonValueCents
required
number
lostCount
required
number
lostValueCents
required
number
tasksDone
required
number
tasksLate
required
number
byCompany
required
Top 20 companies by revenue won in the period, with their open pipeline
Array<object>
object
companyId
required
string
name
required
string
wonCount
required
number
wonValueCents
required
number
openCount
required
number
openValueCents
required
number
Example
{ "period": "7"}