Count all occurences on a particular field (default on created_at) by a particular period, starting from the first occurence to now.

settings Params

Param name Description
field optional . Must be one of: created_at, updated_at, expire_at.

The date field to graph on. Default to created_at.

interval optional . Must be one of: day, week, month, quarter, year, hour_of_day, day_of_week, day_of_month, month_of_year.

The interval to graph by. Default to month_of_year.

sort optional . Must be one of: id, author, title, text, kind, created_at, updated_at, image, expire_at, link, notificable_id, notificable_type.

The sort field. Sorted by expire_at desc, id desc by default.

Example:

To sort on announcements on the fields notificable_id on a descending order and notificable_type on a ascending order:

...&sort=-notificable_id,notificable_type

filter optional . Must be one of: id, author, title, text, kind, created_at, updated_at, image, expire_at, link, notificable_id, notificable_type, expire.

Filtering on one or more fields

Example:

To filter on announcements with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • author (standard field)
  • title (standard field)
  • text (standard field)
  • kind (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • image (standard field)
  • expire_at (standard field)
  • link (standard field)
  • notificable_id (standard field)
  • notificable_type (standard field)
  • expire (standard field)
range optional . Must be one of: id, author, title, text, kind, created_at, updated_at, image, expire_at, link, notificable_id, notificable_type.

Select on a particular range

Example:

To range on announcements with the notificable_type field between min_value and max_value:

...&range[notificable_type]=min_value,max_value

Rangeable fields:
  • id
  • author
  • title
  • text
  • kind
  • created_at
  • updated_at
  • image
  • expire_at
  • link
  • notificable_id
  • notificable_type
GET /v2/announcements/graph/on/created_at/by/day
200
{
  "2017-11-22": 4
}
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/announcements/graph/on/created_at/by/day"

{
  "2017-11-22": 4
}
require "oauth2"
UID = "Your application uid"
SECRET = "Your application secret"
client = OAuth2::Client.new(UID, SECRET, site: "https://api.intra.42.fr")
token = client.client_credentials.get_token

response = token.get("/v2/announcements/graph/on/created_at/by/day")
response.status
# => 200
response.parsed
# => {"2017-11-22"=>4}