Network Groups API Overview

The Network Groups API allows users to retrieve information about network groups. Network groups are a collection of networks that are related (eg. Impact Sweden, Impact UK, Impact US, Impact France, etc.).

Endpoint

GET /v1/network-groups

API Description

The Network Groups API is designed to offer users a convenient way to access network group information. Network groups consist of related networks, and this API enables users to efficiently retrieve details about these groups, such as their IDs and names. By supporting pagination, the API ensures that users can handle large volumes of data in a structured and manageable manner. This API is essential for applications that need to display or process information about various network groups, providing an organized view of related networks across different regions or categories.

Response

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

{
    "meta": {
        "total": 34,
        "from": 4,
        "to": 6,
        "current_page": 2,
        "last_page": 12,
        "per_page": "3",
        "fields": ["id", "name"]
    },
    "data": [
        {"id": 10001, "name": "Adrecord"},
        {"id": 10002, "name": "Adtraction"},
        {"id": 10004, "name": "Avangate"},
        ...
}

Response Fields

Main Response

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

`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 group` Object

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

Parameters

Parameter Name	Type	Required	Description
`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.

Network Groups

Network Groups API Overview#

Endpoint#

API Description#

Response#

Response Fields#

Main Response#

meta Object#

data Array#

network group Object#

Parameters#