Labels

Operations for labels

Find All

GET /v1/networks/labels

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/labels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
  "labels": [
    {
      "label": "",
      "advertiser_ids": [
        0
      ],
      "affiliate_ids": [
        0
      ],
      "campaign_ids": [
        0
      ],
      "offer_ids": [
        0
      ],
      "offer_group_ids": [
        0
      ],
      "relationship": {
        "advertisers": [
          {
            "network_advertiser_id": 0,
            "network_id": 0,
            "name": "",
            "account_status": "active"
          }
        ],
        "affiliates": [
          {
            "network_affiliate_id": 0,
            "network_id": 0,
            "name": "",
            "account_status": "active"
          }
        ],
        "campaigns": [
          {
            "network_campaign_id": 0,
            "network_id": 0,
            "campaign_name": "",
            "campaign_status": "active"
          }
        ],
        "offers": [
          {
            "network_offer_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "network_offer_group_id": 0,
            "name": "",
            "offer_status": "active",
            "network_tracking_domain_id": 0,
            "visibility": "public",
            "currency_id": ""
          }
        ],
        "offer_groups": [
          {
            "network_offer_group_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "name": "",
            "offer_group_status": "active",
            "offer_count": 0
          }
        ]
      }
    }
  ]
}

Find By Label

GET /v1/networks/labels/:label

Path Parameters

Parameter	Description
label	The label you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/labels/<INSERT LABEL>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

 {
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ],
  "relationship": {
    "advertisers": [
      {
        "network_advertiser_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active"
      }
    ],
    "affiliates": [
      {
        "network_affiliate_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active"
      }
    ],
    "campaigns": [
      {
        "network_campaign_id": 0,
        "network_id": 0,
        "campaign_name": "",
        "campaign_status": "active"
      }
    ],
    "offers": [
      {
        "network_offer_id": 0,
        "network_id": 0,
        "network_advertiser_id": 0,
        "network_offer_group_id": 0,
        "name": "",
        "offer_status": "active",
        "network_tracking_domain_id": 0,
        "visibility": "public",
        "currency_id": ""
      }
    ],
    "offer_groups": [
      {
        "network_offer_group_id": 0,
        "network_id": 0,
        "network_advertiser_id": 0,
        "name": "",
        "offer_group_status": "active",
        "offer_count": 0
      }
    ]
  }
}

Create

POST /v1/networks/labels

Body Params

Note: At least one of advertiser_ids, affiliate_ids, campaign_ids, offer_ids, offer_group_ids, must have at least one entry.

label string

The label you want to add.

advertiser_ids array[int]

Which advertisers will have the label.

affiliate_ids array[int]

Which affiliates will have the label.

campaign_ids array[int]

Which campaigns will have the label.

offer_ids array[int]

Which offers will have the label.

offer_group_ids array[int]

Which offer groups will have the label.

Payload Example

{
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ]
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/labels' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Update

PUT /v1/networks/labels?old_label=:oldLabel

Path Parameters

Parameter	Description
oldLabel	The label to be updated (previous value)

Body Params

Note: At least one of advertiser_ids, affiliate_ids, campaign_ids, offer_ids, offer_group_ids, must have at least one entry.

label string

The label you want to add.

advertiser_ids array[int]

Which advertisers will have the label.

affiliate_ids array[int]

Which affiliates will have the label.

campaign_ids array[int]

Which campaigns will have the label.

offer_ids array[int]

Which offers will have the label.

offer_group_ids array[int]

Which offer groups will have the label.

Payload Example

{
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ]
}

Request Example

cURL

curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/labels?old_label=<INSERT OLD LABEL>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Delete

DELETE /v1/networks/labels?label=:label

Path Parameters

Parameter	Description
label	The label to be deleted

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/labels?label=<INSERT LABEL>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \

Response

{
  "result": true
}