Entrar

Listar campanhas

GET https://{organization}.myguper.com/api/loyalty/campaign

Lista paginada das campanhas de fidelidade/cashback. Filtra por nome, gatilho ou tipo pela gramática comum de listagem. Devolve a configuração da campanha, não os resultados — para cards gerados, valor distribuído e resgatado, use o relatório da campanha.

Cada linha traz um status derivado: active, draft, paused ou finished. draft é a campanha salva e ainda não publicada (isDraft): nunca executa e prevalece sobre qualquer outro status. finished não é coluna: nas campanhas audience-list significa que o envio terminou (audience-status = finished); em todos os outros gatilhos significa que a vigência (finishAt) acabou. finished prevalece sobre o isActive — campanha com a vigência vencida e ainda ligada volta como finished. O status é só leitura: nunca altera o isActive.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros de query

Name Type Description
q[column][operator] string Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table.
o[column] string Sort by column. Direction: `ASC`, `DESC`, `1` or `0`.
e integer Linhas por página.
padrão: 20
p integer Número da página.
padrão: 1
status string
active | draft | paused | finished
Só as campanhas nesse status derivado. Um de `active`, `draft`, `paused`, `finished`.
statusCounts integer Com `1`, a resposta ganha `statusCounts` (`{active, draft, paused, finished}`), calculado com os mesmos filtros `q[...]` e ignorando o `status`.
sortByStatus integer Com `1`, as ativas vêm primeiro, depois os rascunhos, as pausadas e por último as encerradas; a ordenação pedida vale dentro de cada grupo.
q[field][OP] string Filtro padrão do Listing. `OP` é o código do operador (`S` exato, `L` contém, `IN`, ...).

Respostas

Relacionados

Copied to clipboard