Recursos para IA
Ativar criação automática

Cria uma programação diária, semanal ou mensal para gerar automaticamente relatórios de Outras operações a partir de uma configuração existente, identificada pelo structure_id. Em caso de sucesso, a requisição retorna uma resposta com status 201.

POST

https://api.mercadopago.com/v1/reporting/operations/{reportId}/schedule
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Path
reportId
string

OBRIGATÓRIO

Tipo de relatório de Outras operações.
activities_collection: Relatório de cobranças.
activities_after_collection: Relatório pós-cobrança.
activities_withdraw: Relatório de retiradas.
Body
type
string

OBRIGATÓRIO

Tipo de configuração da programação. O único valor possível é frequency.
frequency: Gera o relatório de acordo com a frequência configurada em `data`.
data
object

OBRIGATÓRIO

Dados que definem a frequência e o horário em que o relatório é gerado.
structure_id
string

OBRIGATÓRIO

UUID da configuração do relatório para a qual a programação será criada.
notifiers
array
Lista de UUIDs dos notificadores enviados com a requisição de programação. Obtenha esses identificadores na configuração do relatório.
Response parameters
id
string
Identificador único da programação criada.
status
string
Status atual da programação.
active: A programação está ativa e gerará relatórios de acordo com a frequência configurada.
type
string
Tipo de configuração da programação.
frequency: O relatório é gerado de acordo com a frequência configurada.
data
object
Configurações de frequência da programação criada.
Erros

400Campos da programação inválidos.

validation_error

Um ou mais campos da programação são inválidos. Use frequency como type, defina period como daily, weekly ou monthly, informe uma hour de 0 a 23 e envie um structure_id válido. Depois, envie a requisição novamente.

404Configuração não encontrada.

configuration_not_found

Nenhuma configuração corresponde ao reportId e ao structure_id informados. Consulte a configuração ativa e verifique seu identificador ou crie uma configuração antes de programar o relatório.

409Já existe uma programação ativa.

schedule_already_exists

Já existe uma programação ativa para a configuração do relatório. Mantenha a programação existente ou desative a criação automática antes de criar uma nova.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/reporting/operations/{reportId}/schedule'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-1*********550113-12*********b4773884a*********e8df16347*********786' \
    -d '{
  "type": "frequency",
  "data": {
    "hour": 0,
    "value": 1
  }
}'
Response
{
  "id": "bd6d0d3c-7303-476b-a25a-4090036dcee8",
  "data": {
    "hour": 6,
    "value": 1
  }
}