Alma logo
API docs by Redocly

Statistics API (1.0)

Download OpenAPI specification:Download

Introduction

The statistics API is a read-only API providing access to various statistics related to announcements.

Announcement statistics are available both at the level of an individual announcement as well as at the level of an agency office.

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Announcement Summary

Fetch announcement summaries

Fetch announcement summaries

Fetch announcement summaries matching the search criteria. An announcement summary includes basic information related to a specific announcement as well as some lifetime statistics of the announcement.

Exactly one of the parameters announcementId and agencyOfficeId must be specified.

Usage examples

List summaries for sales announcements of an agency office that have been visible within the specified time period

GET /announcementSummaries?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&visibleWithinTimePeriod=LAST_7_DAYS

GET /announcementSummaries?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&visibleWithinTimePeriod=2021-W14

Get summary for a specific sales announcement

GET /announcementSummaries?announcementType=SALES_ANNOUNCEMENT&announcementId=1038356

Authorizations:
bearerAuth
query Parameters
announcementType
required
string
Enum: "SALES_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT"
Example: announcementType=SALES_ANNOUNCEMENT

Type of the announcement. Only a single value is allowed for now, used for forwards compatibility.

announcementId
string
Example: announcementId=1038356

The unique identifier of Etuovi.com announcement.

agencyOfficeId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e

Agency office identifier

visibleWithinTimePeriod
string
Example: visibleWithinTimePeriod=2021-W21

Only return data for announcements that have been visible during the specified time period

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Unique identifier of the call as determined by the initiating party. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Announcement Statistics

Fetch announcement statistics

Fetch announcement statistics

Fetch announcement statistics matching the search criteria.

The statistics are aggregated over a specific time period such as a day or a month. Period-on-period deltas of the metrics can be requested optionally

Exactly one of the parameters announcementId and agencyOfficeId must be specified, i.e. statistics can be retrieved for either a specific announcement or for all announcements of a specific agency office.

Either the parameter timePeriod or one or both of the parameters startTimePeriod and endTimePeriod may be specified at the same time.

Usage examples

List daily statistics for an announcement

GET /announcementStatistics?announcementType=SALES_ANNOUNCEMENT&announcementId=1038356&aggregationPeriod=DAY

List weekly and monthly statistics for an announcement

GET /announcementStatistics?announcementType=SALES_ANNOUNCEMENT&announcementId=1038356&aggregationPeriod=WEEK

GET /announcementStatistics?announcementType=SALES_ANNOUNCEMENT&announcementId=1038356&aggregationPeriod=MONTH&startTimePeriod=2021-01&endTimePeriod=2021-02

List statistics for the last 7 days for a specific sales announcement

GET /announcementStatistics?announcementType=SALES_ANNOUNCEMENT&announcementId=1038356&aggregationPeriod=ROLLING_7_DAYS&timePeriod=LAST_7_DAYS

List statistics for top 5 sales announcements of a specified agency office for the specified time period

GET /announcementStatistics?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&aggregationPeriod=ROLLING_7_DAYS&timePeriod=LAST_7_DAYS

GET /announcementStatistics?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&aggregationPeriod=WEEK&timePeriod=2021-W10

Authorizations:
bearerAuth
query Parameters
announcementType
required
string
Enum: "SALES_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT"
Example: announcementType=SALES_ANNOUNCEMENT

Type of the announcement. Only a single value is allowed for now, used for forwards compatibility.

announcementId
string
Example: announcementId=1038356

The unique identifier of Etuovi.com announcement.

agencyOfficeId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e

Agency office identifier

aggregationPeriod
required
string
Enum: "DAY" "WEEK" "MONTH" "ROLLING_7_DAYS"
Example: aggregationPeriod=WEEK

The period the statistics have been aggregated over

timePeriod
string
Example: timePeriod=2021-W10

The time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod.

When aggregationPeriod=DAY the allowed values are dates in ISO 8601 format, e.g. 2021-03-04.

When aggregationPeriod=WEEK the allowed values are weeks in the ISO 8601 week date system, e.g. 2021-W02.

When aggregationPeriod=MONTH the allowed values are months in ISO 8601 like format, e.g. 2021-05.

When aggregationPeriod=ROLLING_7_DAYS the only allowed value is LAST_7_DAYS which means the last seven days not including the current one.

startTimePeriod
string
Example: startTimePeriod=2021-W01

The (inclusive) start time period specifying the minimum time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod and are the same as for the parameter timePeriod.

endTimePeriod
string
Example: endTimePeriod=2021-W03

The (inclusive) end time period specifying the maximum time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod and are the same as for the parameter timePeriod.

includeDeltas
boolean
Default: false
Example: includeDeltas=true

Flag to indicate whether period-on-period deltas should be included in the returned statistics

includeAnnouncementDetails
boolean
Default: false
Example: includeAnnouncementDetails=true

Flag to indicate whether announcement details should be included in the returned statistics

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Unique identifier of the call as determined by the initiating party. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Announcement Action

Fetch announcement actions

Fetch announcement actions

Fetch announcement actions matching the search criteria

Usage examples

GET /announcementActions?announcementId=1038356&announcementType=SALES_ANNOUNCEMENT

Authorizations:
bearerAuth
query Parameters
announcementType
required
string
Enum: "SALES_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT"
Example: announcementType=SALES_ANNOUNCEMENT

Type of the announcement. Only a single value is allowed for now, used for forwards compatibility.

announcementId
required
string
Example: announcementId=1038356

The unique identifier of Etuovi.com announcement.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Agency Office Statistics

Fetch agency office statistics

Fetch agency office statistics

Fetch periodic agency office statistics matching the search criteria. Period-on-period deltas of the metrics can be requested optionally

Either the parameter timePeriod or one or both of the parameters startTimePeriod and endTimePeriod may be specified at the same time.

Usage examples

Get announcement statistics of a specified agency office for sales announcements for the last 7 days, including deltas

GET /agencyOfficeStatistics?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&aggregationPeriod=ROLLING_7_DAYS&timePeriod=LAST_7_DAYS&includeDeltas=true

Get weekly office statistics of a specified agency office for sales announcements for the specified calendar week including deltas

GET /agencyOfficeAnnouncementStatistics?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENT&aggregationPeriod=WEEK&timePeriod=2021-W13&includeDeltas=true

Get daily office statistics for a specified agency office for sales announcements for a specified time range

GET /agencyOfficeAnnouncementStatistics?agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e&announcementType=SALES_ANNOUNCEMENTaggregationPeriod=DAY&startTimePeriod=2021-02-01&endTimePeriod=2021-02-14

Authorizations:
bearerAuth
query Parameters
announcementType
required
string
Enum: "SALES_ANNOUNCEMENT" "RENTAL_ANNOUNCEMENT"
Example: announcementType=SALES_ANNOUNCEMENT

Type of the announcement. Only a single value is allowed for now, used for forwards compatibility.

agencyOfficeId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agencyOfficeId=ac9de83f-2101-4d1a-a2fa-2e472d646e6e

Agency office identifier

aggregationPeriod
required
string
Enum: "DAY" "WEEK" "MONTH" "ROLLING_7_DAYS"
Example: aggregationPeriod=WEEK

The period the statistics have been aggregated over

timePeriod
string
Example: timePeriod=2021-W10

The time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod.

When aggregationPeriod=DAY the allowed values are dates in ISO 8601 format, e.g. 2021-03-04.

When aggregationPeriod=WEEK the allowed values are weeks in the ISO 8601 week date system, e.g. 2021-W02.

When aggregationPeriod=MONTH the allowed values are months in ISO 8601 like format, e.g. 2021-05.

When aggregationPeriod=ROLLING_7_DAYS the only allowed value is LAST_7_DAYS which means the last seven days not including the current one.

startTimePeriod
string
Example: startTimePeriod=2021-W01

The (inclusive) start time period specifying the minimum time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod and are the same as for the parameter timePeriod.

endTimePeriod
string
Example: endTimePeriod=2021-W03

The (inclusive) end time period specifying the maximum time period to return statistics for. The allowed values depend on the value of the parameter aggregationPeriod and are the same as for the parameter timePeriod.

includeDeltas
boolean
Default: false
Example: includeDeltas=true

Flag to indicate whether period-on-period deltas should be included in the returned statistics

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]