Collabim REST API General Overview

Actions to HTTP methods:

General notes

Collabim Sections with API Access support

Projects

GET https://api.oncollabim.com/projects - displays list of projects

Filter

Expected value

Description

Example call

nameLike

string

Displays projects whose name contains string specified in filter.

/projects?nameLike=letuska

active

1 or 0

Displays active (1) or archived (0) projects.

/projects?active=1

page

integer

Displays 10 projects per page. Default value is 1.

/projects?page=1

itemsPerPage

integer

Change number of results per page. Default is 20.

/projects?itemsPerPage=1

GET https://api.oncollabim.com/projects/[projectId] - displays attributes of project with id = [projectId]

Example call: GET /projects/5

Activities

GET https://api.oncollabim.com/activities - displays list of activities

Filter

Expected value

Description

Example call

projectId

integer

Displays activities assigned to specified project.

/activities?projectId=2

typeId

integer

Displays activities of a specified type only (backlinks, articles etc.)

/activities?typeId=4

stateId

integer

Displays activities in a specified state only (completed, queued, postponed etc.)

/activities?stateId=1

createdById

integer

Displays activities created by a specified person only.

/activities?createdById=8

categoryId

integer

Displays activities assigned to a specified category only.

This filter must NOT be combined with noCategory filter.

/activities?categoryId=10

noCategory

1 or 0

Displays activities that are not given any category.

This filter must NOT be combined with categoryId filter.

/activities?noCategory=1

addedOnFrom

date (YYYY-MM-DD)

Displays activities that were created after given date.

/activities?addedOnFrom=2012-01-31

addedOnTo

date (YYYY-MM-DD)

Displays activities that were created before given date.

/activities?addedOnTo=2012-02-28

urlLike

string

Display activities whose web URL or page with link URL contains specified string.

/activities?urlLike=topgal.cz

webId

integer

Displays activities assigned to a specified website only.

/activities?webId=120

page

integer

Displays 10 projects per page. Default value is 1.

/activities?page=2

itemsPerPage

integer

Change number of results per page. Default is 20.

/activities?itemsPerPage=1

GET https://api.oncollabim.com/activities/[activityId] - displays attributes of activity with id = [activityId]

Example call: GET https://api.oncollabim.com/activities/128

POST https://api.oncollabim.com/activities - inserts a new activity

Mandatory attributes: projectId, typeId, stateId, (webId OR webSiteUrl) - see bellow

PUT https://api.oncollabim.com/activities/[activityId] - updates attributes of activity with id = [activityId]

Attribute

Expected value

projectId

integer

typeId

integer

stateId

integer

categoryId

integer

createdById

integer

webId

integer

note

string

pageWithLinkUrl

string (URL)

webSiteUrl

string (URL)

DELETE https://api.oncollabim.com/activities/[activityId] - deletes activity with id = [activityId]

Example call: DELETE https://api.oncollabim.com/activities/128

Keywords

GET https://api.oncollabim.com/keywords - displays list of keywords

Filter

Expected value

Description

Example call

projectId

integer

Displays keywords assigned to specified project.

/keywords?projectId=5

keyword

string

Displays keyword with specified text only (exact match).

/keywords?keyword=iphone4s

keywordLike

string

Displays keywords whose name contains specified string.

/keywords?keywordLike=iphone

tags

string

Displays keywords assigned with at least one of given tags

/keywords?tags=hokejky+brusle

targetPageId

integer

Displays keywords assigned to specified target page.

/keywords?groupId=1243

starred

1 or 0

Displays keywords marked with a star (1) or keywords without star (0)

/keywords?starred=1

page

integer

Displays 10 projects per page. Default value is 1.

/keywords?page=2

itemsPerPage

integer

Change number of results per page. Default is 10.

/keywords?itemsPerPage=1

showSearchEngineName

1 or 0

Show name of search engine instead of id

/keywords?showSearchEngineName=1

Also see the list of supported search engines.

Keyword positions (including history)

GET https://api.oncollabim.com/keyword-positions - displays history of positions for given keywords

All the following arguments
are mandatory:

Filter
(expected value)

Expected value

Description

Example call

projectId

integer

Select positions for given project only

/keyword-positions?projectId=5

projectKeywordIds

Integer list

Return keywords with given IDs only

/keyword-positions?projectKeywordIds=1,15,3195

from

date (YYYY-MM-DD)

Return positions from given date only

/keyword-positions?from=2013-12-28

to

date (YYYY-MM-DD)

Return positions to given date only

/keyword-positions?to=2014-01-31

showSearchEngineName

1 or 0

Show name of search engine instead of id

/keyword-positions?showSearchEngineName=1

lastXDays

integer

Return position to given days back

/keyword-positions?lastXDays=30

tags

string

Displays keywords assigned with at least one of given tags

/keyword-positions?tags=hokejky+brusle

Limit of project keywords dynamically depends on day interval by the following calculation: 7000 / day interval (lastXDays or difference between from and to).

Also see the list of supported search engines.

Indexed pages (including history)

GET https://api.oncollabim.com/indexed-pages - displays indexed pages for given project

All the following arguments except searchEngineId
are mandatory:

Filter
(expected value)

Expected value

Description

Example call

projectId

integer

Show indexed pages stats for given project only

/indexed-pages?projectId=5

searchEngineId

integer

Show indexed pages stats for given search engine

/indexed-pages?searchEngineId=1

from

date (YYYY-MM-DD)

Show indexed pages stats from given date only

/indexed-pages?from=2013-12-28

to

date (YYYY-MM-DD)

Show indexed pages stats to given date only

/indexed-pages?to=2014-01-31

showSearchEngineName

1 or 0

Show name of search engine instead of id

/indexed-pages?showSearchEngineName=1

lastXDays

integer

Return indexed pages stats for given days back

/indexed-pages?lastXDays=30

Also see the list of supported search engines.