Campaigns collection - Dintero Documentation

aid_discounts_campaigns_get

curl --request GET \
  --url https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "deleted_at": "2023-11-07T05:31:56Z",
    "campaign_id": "<string>",
    "description": "<string>",
    "private": false,
    "metadata": {
      "sponsor": "Solo",
      "is_featured": true
    },
    "statistics": {
      "rules": 123,
      "used": 123,
      "amount": 123,
      "purchase_from": "2023-11-07T05:31:56Z",
      "purchase_to": "2023-11-07T05:31:56Z"
    }
  }
]

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

GET

https://api.dintero.com/v1

accounts

{aid}

discounts

campaigns

aid_discounts_campaigns_get

curl --request GET \
  --url https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/discounts/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "deleted_at": "2023-11-07T05:31:56Z",
    "campaign_id": "<string>",
    "description": "<string>",
    "private": false,
    "metadata": {
      "sponsor": "Solo",
      "is_featured": true
    },
    "statistics": {
      "rules": 123,
      "used": 123,
      "amount": 123,
      "purchase_from": "2023-11-07T05:31:56Z",
      "purchase_to": "2023-11-07T05:31:56Z"
    }
  }
]

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

Authorization: Bearer {access_token}

where the access_token is JSON Web Tokens (JWT).

Path Parameters

aid

string<^[PT]{1}\d{8}$>

required

An id that uniquely identifies the account.

Required string length: 9

Query Parameters

limit

integer

default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

Required range: 1 <= x <= 100

starting_after

string

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

state

enum<string>

default:all

Indicate the state of the campaign to return.

active, scheduled and completed are based on the campaign's rules that are not deleted: active when the earliest requirement.purchase_from is in the past and the latest requirement.purchase_to is in the future, scheduled when the earliest requirement.purchase_from is in the future, and completed when the latest requirement.purchase_to is in the past. Campaigns without rules are only returned by all, public, private and deleted.

Available options:

all,

public,

private,

deleted,

active,

scheduled,

completed

string

Only campaigns where name, description or campaign_id contains this text (case-insensitive)

include

enum<string>[]

Additional fields to include for each campaign

Available options:

statistics

Response

Campaign collection

name

string

required

string<uuid>

read-only

An UUID that uniquely identifies the resource

created_at

string<date-time>

read-only

The date-time when the resource was created

created_by

string

read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

updated_at

string<date-time>

read-only

The date-time when the resource was last updated

deleted_by

string

read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

deleted_at

string<date-time>

read-only

campaign_id

string

Maximum string length: 255

description

string

private

boolean

default:false

The campaign is private and will be excluded from public rules when filtered by campaign_id

GET /discounts/public/rules

metadata

object

Additional metadata about the campaign

Example:

{ "sponsor": "Solo", "is_featured": true }

statistics

object

read-only

Only included when include=statistics. Aggregated over the campaign's rules that are not deleted.

Show child attributes