Google Postmaster Tools

This API provides access to Google Postmaster data.

Get GPT Domain

Returns domain records for a single domain on the account. Each domain record is for a single domain on a single day.

SecuritybasicAuth
Request
path Parameters
domain
required
string
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
domain
required
string
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/domains/{domain}
Request samples
Response samples
application/json
{
  • "domain": "test.com",
  • "data": [
    • {
      }
    ]
}

Get GPT Domains

Returns a list of all domain records for an account. Each domain record is for a single domain on a single day.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
domain
required
string
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/domains
Request samples
Response samples
application/json
{
  • "data": [
    • {
      }
    ],
  • "domain": "test.com"
}

Get GPT Domain Addresses

Returns a list of all address records for an account belonging to a specific domain. Each address record is for a single address on a single day.

SecuritybasicAuth
Request
path Parameters
domain
required
string
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
domain
required
string
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/domains/{domain}/addresses
Request samples
Response samples
application/json
{
  • "domain": "test.com",
  • "data": [
    • {
      }
    ]
}

Get GPT Domains Summary

Returns a list of all domain summary records for an account. Each record is for a single domain's summary data.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

sortBy
required
string

Field name to sort by.

orderBy
required
string

'Asc' or 'desc' sorting.

searchField
required
string

Value of the domain to search, example: mailgun.com

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/summary/domains
Request samples
Response samples
application/json
{
  • "summary": [
    • {
      }
    ]
}

Get GPT Domains Error Summary

Returns a list of all domain error summary records for an account. Each record is for a single domain's error summary data.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

sortBy
required
string

Field name to sort by.

orderBy
required
string

'Asc' or 'desc' sorting.

searchField
required
string

Value of the domain to search, example: mailgun.com

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/summary/errors
Request samples
Response samples
application/json
{
  • "summary": [
    • {
      }
    ]
}

Get GPT Address

Returns address records for an single address on the account. Each address record is for a single address on a single day.

SecuritybasicAuth
Request
path Parameters
address
required
string
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
address
required
string
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/addresses/{address}
Request samples
Response samples
application/json
{
  • "data": [
    • {
      }
    ],
  • "address": "0.0.0.0"
}

Get GPT Addresses

Returns a list of all address records for an account. Each address record is for a single address on a single day.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
address
required
string
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/addresses
Request samples
Response samples
application/json
{
  • "address": "0.0.0.0",
  • "data": [
    • {
      }
    ]
}

Get GPT Addresses Summary

Returns a list of all address summary records for an account. Each record is for a single address's summary data.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

sortBy
required
string

Field name to sort by.

orderBy
required
string

'Asc' or 'desc' sorting.

searchField
required
string

Value of the address to search, example: 127.0.0.1

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
required
object
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/summary/addresses
Request samples
Response samples
application/json
{
  • "summary": [
    • {
      }
    ]
}

Get GPT Summary

Returns a list of all summary records for an account. Each record is for a single domain's summary and error summary data.

SecuritybasicAuth
Request
query Parameters
offset
required
integer

The record number to begin pagination with.

limit
required
integer

The number of records to return.

timeRangeStart
required
integer

Unix timestamp starting time filter.

timeRangeEnd
required
integer

Unix timestamp ending time filter.

sortBy
required
string

Field name to sort by.

orderBy
required
string

'Asc' or 'desc' sorting.

searchField
required
string

Value of the domain to search, example: mailgun.com

header Parameters
X-Mailgun-Account-Id
required
string

The account id

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
total
required
integer <int32>
400

A 400 response

404

A 404 response

500

A 500 response

get/v1/reputationanalytics/gpt/summary
Request samples
Response samples
application/json
{
  • "summary": [
    • {
      }
    ]
}