Pular para o conteúdo

POST /v1/analytics/sales/month/search

POST
/v1/analytics/sales/month/search
curl --request POST \
--url https://seu-endereco-da-api/v1/analytics/sales/month/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "month": "example" }'

Permissão que a Chave de acesso precisa: Relatórios de vendas (analytics:sales).

Media typeapplication/json
object
month
string

Example generated

{
"month": "example"
}
Media typeapplication/json
object
month
required
string
window
required

The 1st to the last day of the month, or to today in the current month, in the account time zone

object
firstDay
required
string
lastDay
required
string
kpis
required
object
wonValue
required

Cents

number
wonCount
required
number
createdCount
required
number
sellers
required

Deal owners who won in the month, the most deals won first

Array<object>
object
userId
required
string
name
required
string
nullable
wonCount
required
number
wonValue
required

Cents

number

Example generated

{
"month": "example",
"window": {
"firstDay": "example",
"lastDay": "example"
},
"kpis": {
"wonValue": 1,
"wonCount": 1,
"createdCount": 1
},
"sellers": [
{
"userId": "example",
"name": "example",
"wonCount": 1,
"wonValue": 1
}
]
}