GET api/v1/search/artists
Record search criteria for an artist search
Request Information
URI Parameters
None.
Body Parameters
ArtistSearchBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication | AuthenticationModel |
Required |
|
| Request | ArtistSearchRequestModel |
Required |
Request Formats
application/json, text/json
Sample:
{
"Authentication": {
"Id": "170200123 - sample only, user your ID",
"Key": "467512342123 - sample only, user your Key"
},
"Request": {
"Email": "larry@newmedia.com",
"SoftwareName": "Maya",
"State": "CA",
"CountryName": "United States of America",
"Country2AlphaCode": "US",
"Country3AlphaCode": "USA",
"CountryNumericCode": "840",
"PredefinedRange": "this month | this year | last month | last year | today | yesterday - don't include Range if this field is populated",
"Range": {
"StartDate": "2025-12-03 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)",
"EndDate": "2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)"
},
"SortBy": "UserName/TotalUsage/WorkstationUsage/RenderUsage/LastUsed/Location",
"Ascending": "true/false"
}
}
application/xml, text/xml
Sample:
<ArtistSearchBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
<Authentication>
<Id>170200123 - sample only, user your ID</Id>
<Key>467512342123 - sample only, user your Key</Key>
</Authentication>
<Request>
<Ascending>true/false</Ascending>
<Country2AlphaCode>US</Country2AlphaCode>
<Country3AlphaCode>USA</Country3AlphaCode>
<CountryName>United States of America</CountryName>
<CountryNumericCode>840</CountryNumericCode>
<Email>larry@newmedia.com</Email>
<PredefinedRange>this month | this year | last month | last year | today | yesterday - don't include Range if this field is populated</PredefinedRange>
<Range>
<EndDate>2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</EndDate>
<StartDate>2025-12-03 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</StartDate>
</Range>
<SoftwareName>Maya</SoftwareName>
<SortBy>UserName/TotalUsage/WorkstationUsage/RenderUsage/LastUsed/Location</SortBy>
<State>CA</State>
</Request>
</ArtistSearchBindingModel>
Response Information
Resource Description
SearchOutgoingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | MessageModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Message": {
"Code": "sample string 1",
"Description": "sample string 2"
}
}
application/xml, text/xml
Sample:
<SearchOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
<Message>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</Message>
</SearchOutgoingModel>