Networks API Overview

The Networks API allows users to retrieve detailed information about affilate networks. This API provides comprehensive details about these affiliate networks, including their identifiers, names, logos, merchant counts, product counts, associated groups, and countries.

Endpoint

GET /v1/networks

API Description

The Networks API is designed to provide users with detailed information about individual affiliate networks. Each network may have its own set of merchants, products, and specific characteristics. This API facilitates the retrieval of such detailed information, supporting pagination to manage large sets of data efficiently. Users can leverage this information to display, analyze, or manage network data within their applications.

Response

A successful response returns a JSON object with metadata about the pagination and an array of network details.

{
  "meta": {
    "total": 0,
    "from": 1,
    "to": 0,
    "current_page": 1,
    "last_page": 0,
    "per_page": 100,
    "fields": [
      "id",
      "name",
      "logo_url",
      "merchant_count",
      "merchant_count_active",
      "product_count",
      "group",
      "country"
    ]
  },
  "data": [
    {
      "id": 211,
      "name": "ClixGalore Australia",
      "logo_url": "https://api.affili8.dev/img/logos/groups/10011/128x128.png",
      "merchant_count": 398,
      "merchant_count_active": 13,
      "product_count": 61972,
      "group": {
        "id": 10011,
        "name": "ClixGalore"
      },
      "country": {
        "id": "AU",
        "iso3": "AUS",
        "name": "Australia"
      }
    },
    {
      "id": 212,
      "name": "ClixGalore New Zealand",
      "logo_url": "https://api.affili8.dev/img/logos/groups/10011/128x128.png",
      "merchant_count": 39,
      "merchant_count_active": 2,
      "product_count": 652,
      "group": {
        "id": 10011,
        "name": "ClixGalore"
      },
      "country": {
        "id": "NZ",
        "iso3": "NZL",
        "name": "New Zealand"
      }
    },
    {
      "id": 213,
      "name": "ClixGalore UK",
      "logo_url": "https://api.affili8.dev/img/logos/groups/10011/128x128.png",
      "merchant_count": 139,
      "merchant_count_active": 3,
      "product_count": 742,
      "group": {
        "id": 10011,
        "name": "ClixGalore"
      },
      "country": {
        "id": "GB",
        "iso3": "GBR",
        "name": "United Kingdom"
      }
    },
    {
      "id": 221,
      "name": "Webgains UK Coupons/Deals",
      "logo_url": "https://api.affili8.dev/img/logos/groups/10036/128x128.png",
      "merchant_count": 1933,
      "merchant_count_active": 0,
      "product_count": 0,
      "group": {
        "id": 10036,
        "name": "Webgains"
      },
      "country": {
        "id": "GB",
        "iso3": "GBR",
        "name": "United Kingdom"
      }
    }
  ]
}

Response Fields

Main Response

Field Name	Type	Description
`meta`	object	Metadata about the pagination.
`data`	array	The array of networks.

`meta` Object

Field Name	Type	Description
`total`	integer	The total number of items.
`limit`	integer	The number of items per page.
`offset`	integer	The offset of the current page.

`data` Array

`network` Object

Field Name	Type	Description
`id`	integer	The unique identifier of the network.
`name`	integer	The name of the network.
`logo_url`	string	The URL of the network's logo.
`merchant_count`	integer	The total number of merchants in the network.
`merchant_count_active`	integer	The number of active merchants in the network.
`product_count`	integer	The total number of products in the network.
`group`	object	The group to which the network belongs.
`country`	object	The country associated with the network.

`group` Object

Field Name	Type	Description
`group.id`	integer	The unique identifier of the group.
`group.name`	string	The name of the group.

`country` Object

Field Name	Type	Description
`country.id`	string	The country code (ISO 3166-1 alpha-2).
`country.iso3`	string	The country code (ISO 3166-1 alpha-3).
`country.name`	string	The name of the country.

Parameters

Parameter Name	Type	Required	Description
`/{id}`	string	No	Filters response to a single network by its ID
`fields`	string	No	Limit to the return to the fields specified
`page`	integer	No	The page number to retrieve. Defaults to 1.
`per_page`	integer	No	The number of items per page. Defaults to 100.
`search`	string	No	The network name you are searching (e.g. `?search=impact`)

Networks

Networks API Overview#

Endpoint#

API Description#

Response#

Response Fields#

Main Response#

meta Object#

data Array#

network Object#

group Object#

country Object#

Parameters#