GET /external/api/v3/customer/count

Count customers.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
TransactionDateFilter	Filter on the transaction date.	DateFilter	None	False
SurveyFinishedDateFilter	Filter on the survey finished date. Note: Includes partially filled customers with a closed batch.	DateFilter	None	False
DateInvitedFilter	Filter on the date the invitation email is sent. Note: Includes only customers who actually received an email, locked customers for example are excluded.	DateFilter	None	False
ScheduledInvitationDateFilter	Filter on the scheduled invitation date.	DateFilter	None	False
OptedOutDateFilter	Filter on the opted-out date.	DateFilter	None	False
BatchClosedDateFilter	Filter on the close date. Customers are considered read-only after this date.	DateFilter	None	False
LastActivityDateFilter	Filter on the last activity date.	DateFilter	None	False
DataFilters	Filter on data.	Collection of CustomerDataFilter	None	False
Statuses	Filter on customer statuses. Get all available statuses and their statuscode with the GetCustomerStatuses method.	Collection of integer	None	False
IsOptout	Filter on opt-out.	boolean	None	True
CustomerIds	Filter on customer ids.	Collection of integer	None	False
EmailAddresses	Filter on email addresses.	Collection of string	None	False
IncludeTestRecords	Include test records. Default value is false.	boolean	None	False
AnswerFilters	Filter customer on their answer, will only return customers with answers with filtered scalepositions.	Collection of CustomerAnswerFilter	None	False

Body Parameters

None.

Response Information

Resource Description

Count of customers

GetCustomerCountResponse

Name	Description	Type	Additional information	Nullable
CustomerCount		integer	None	False

Response Formats

application/json, text/json

Sample:

{
  "CustomerCount": 1
}

application/xml, text/xml

Sample:

<GetCustomerCountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Responses">
  <CustomerCount>1</CustomerCount>
</GetCustomerCountResponse>

Response Status Codes

Status Code	Name	Description
200	OK	The request has succeeded.
400	Bad Request	Fulfilling the request would cause an invalid state. Request needs modification.
401	Unauthorized	Missing or invalid authentication token.
403	Forbidden	Server refuses to authorize the request.
408	Request Timeout	The server timed out waiting for the request.
429	Too Many Requests	Too many requests in a given amount of time.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	Service Unavailable	The server is unable to proces the request at the moment, try again later.