CiviCRM Community Forums (archive)

What I'd like to do is use the API to pull activities for a particular contact by date range (e.g. the last month by default, with a selection to choose earlier months).

Colemanw was giving me some direction on IRC:

<colemanw> laryn: the api does support some operators like >, <, LIKE, BETWEEN, etc ... should be in the api docs somewhere

Unfortunately, I haven't had much luck in my searching to find out appropriate syntax. I've found the following:

• Civi4.1 Wiki entry mentioning "of using 'LIKE', IN, BETWEEN, NOT BETWEEN, NOT LIKE & is_current" such as:
  

$params = array(
  'version' => 3,
  'relationship_type_id' => array(
      'BETWEEN' => array(
          '0' => 33,
          '1' => 35,
        ),
    ),
);

  $result = civicrm_api( 'relationship','get',$params );


[/li]

• An entry on JIRA which may indicate this functionality isn't included?

So far I've tried the following, but am not getting results:
    $params = array(
      'activity_date_time' => array(
          'BETWEEN' => array(
          '0' => '03/01/2013',
          '1' => '03/31/2013',
          ),
      ),     
      'version' => 3,
      'sequential' => 1,
      'source_contact_id' => $source_contact_id,
      'activity_type_id' => $activity_type_id,
      'sort' => 'activity_date_time DESC',
    );

I've also tried modifying it based on the fields in the activity search page (where you can search by range):
    $params = array(
      'activity_date_low' => '03/01/2013',
      'activity_date_high' => '03/31/2013',
      'version' => 3,
      'sequential' => 1,
      'source_contact_id' => $source_contact_id,
      'activity_type_id' => $activity_type_id,
      'sort' => 'activity_date_time DESC',
    );
This last code returns all results without any date filtering, while the first doesn't return any results.

Any guidance or further direction in my search would be greatly appreciated! I will try to update the Wiki with any discoveries... I should probably note I haven't had a chance to update the site that I am working on this with to 4.3 yet (I believe it is at 4.2.8 right now).

The stored example suggests to me that the date is not going through 'strtotime' & you need to use dates that mysql likes eg.

http://svn.civicrm.org/civicrm/branches/v4.2/api/v3/examples/Activity/DateTimeHigh.php


/*
 demonstrates _high filter (at time of writing doesn't work if contact_id is set
 */
function activity_get_example(){
$params = array(
  'source_contact_id' => 17,
  'version' => 3,
  'filter.activity_date_time_high' => '20120101000000',
  'sequential' => 1,
);

  require_once 'api/api.php';
  $result = civicrm_api( 'activity','get',$params );

  return $result;
}

It may not be the reason - I also just noticed filter. in the one param below

Just to follow up -- Eileen gets the gold star! The example she dug up was very instructive and that is the format the date needs to be in.