RPT_GetReport

command

string

Required

RPT_GetReport

uid

string

Required

Your Account ID

pw

string

Required

Your API Token

Version

string

Optional; default is 0

Version of this command. Permitted values are 0 and 1. Use "Version=1" to receive the return parameters listed in the Returned parameters table below. "Version=0" and "Version=1" return parameters vary slightly in the data returned and in the tag names. We recommend that you use "Version=1",which avoids timeouts by supporting paging of results, and queuing of the query.

ReportType

boolean

Required

Type of report to generate. Permitted values are:
0 Registrations
1 Renewals
2 Transfers In
11 Transfers Out
3 Private Label (Instant Reseller and Registry Rocket)
4 Sub-Accounts
5 Accounting
6 Expiring Domains
10 Pricing Editor Updates
13 Business Listing Bulk Update
15 Business Listing Domain Update
16 Transactions
17 Order History
18 Periodic Billing History
20 Premium Registration
21 Monthly Invoices
22 Invoice History
23 Invoice Detail
24 List of Invoices
25 Top Watchlist TLDs
26 Watchlist Summary
27 Top Watchlists
28 All Watchlists
29 All Watchlist Details
30 Domain Name History
31 Domain Verification/Suspension

BeginDate

boolean

Optional; default is the last day of the month, two months before the current month

First date to include in the report. Must be no earlier than six months before today. Use format MM/DD/YYYY

EndDate

string

Optional; default is today’s date

Last date to include in the report. Use format MM/DD/YYYY

Start

string

Optional; default is 1

In the overall list of returns for this report type and date range, the start position for the return to this query.

RecordsToReturn

int

Optional; default is 100 if Download=False

Number of items to return in this report.

Download

boolean

Required

Do you wish to run report in real time or deliver to this account’s Billing contact email address?

Permitted values are:
"True" - Send the report via email
"False" - Real-time and deliver in API response

Reports will always be delivered by email if they extend past four months before today, or if they include more than 25,000 results.

ReportOutputType

string

Required, if "Download=True"

If delivering the report via email, "ReportOutputType" must be 2.

ResponseType

string

Required

Format of response. Permitted value is "XML".

RptString

string

List report descriptions

ThreeMoPast

string

The date three months before today

SixMoPast

string

The date six months before today

BeginDate

string

The first date included in this report

EndDate

string

The last date included in this report

ID

int

Report type identification number

Name

string

Report name

ReportType

string

Report type specified in this query string

ReportName

string

Name of the report type specified in this query string

QueueReportResults

int

Should report results be queued.
Permitted values are:
1 to queue results;
0 to send results immediately via HTTP.

ReportResults

string

Results specific to this report type. The results, and return parameters, vary by report type.

DomainName

string

Domain name

OrderID

int

Order identification number

Commission

float

Commission

SalePrice

float

Sale price

DateApplied

string

Date sale was recorded

LoginID

string

Login ID to which this order was delivered

NewStartPosition

string

In the full list of results, the start position of the next page of results

ThisStartPosition

string

In the full list of results, the position of the first result listed on this page

ThisEndPosition

string

In the full list of results, the position of the last result listed on this page

PreviousStartPosition

string

In the full list of results, the position of the previous page of results

TotalReturned

int

Number of results listed on this page

TotalRows

int

Number of results total for this report

ShowPrevious

string

Should this page show a link to the previous page of results?

ShowNext

string

Should this page show a link to the next page of results?

ShowPaging

string

Should this page show links to previous and next results?

Version

float

Version of this command that generated this return

Command

string

Name of command executed

ErrCount

int

The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

ErrX

string

Error messages explaining the failure. These can be presented as is back to the client.

Done

boolian

"True" indicates this entire response has reached you successfully.