Documentation - Using the Filter Parameter

Both the XML and JSON calls have the ability to use a Filter parameter. When using a JSON call, you must use this parameter to filter your results since the JSON commands do not accept a set of separate variables like the XML calls.

The Filter parameter is used to filter the data by specifying a number of different clauses. You can specify these different clauses by using the object names of the field you want to filter by. This feature allows for much more advanced filtering so you can get the results you're looking for without needing to lots of JavaScript logic to pull out the correct data from the results.

BlogItemInfo.PublicationDate >= '2007/11/01' AND BlogItemInfo.PublicationDate <= '2007/11/30'

The example above is trying to get all the posts published in November 2007. So we want all the posts published on or after November 1, 2007 and on or before November 30, 2007. To specify publication date, we say BlogItemInfo.PublicationDate. If you look at the post.get section above, the response XML has parameters like this:

<ArrayOfBlogItemInfo>
   <BlogItemInfo>
      <Id>402178</Id>
.
.
.
<PublicationDate>2007-05-23T12:00:00</PublicationDate>
.
.
.
   </BlogItemInfo>
</ArrayOfBlogItemInfo>
                        

Notice the red text. The PublicationDate is a child of BlogItemInfo. This means that PublicationDate is a member of the object BlogItemInfo. So when using PublicationDate in the WHERE clause, we specify the object that it is a member of. This is how we get BlogItemInfo.PublicationDate.

To specify the blog item id, we would use BlogItemInfo.Id = 390234.

By using the Filter paramter you can use any member of the object being returned. For the post.get function, you can specify any member of the BlogItemInfo object. All of the members are specified in the response XML for that data type.