- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- SMS Sender Identities
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Pages
- Components
- Website
- Website Domains
- Venue Info
- Landing Pages
- Landing Page Templates
- Articles
- Events
- Events Groups
- Job Postings
- Press Releases
- Tags
- Service Messages
- Content Prototypes
- ContentPrototype Model
- List Content Prototypes
- Show Content Prototype
- Create Content Prototype
- Update Content Prototype
- Destroy Content Prototype
- List Organization Content Prototypes
- Show Organization Content Prototype
- Create Organization Content Prototype
- Update Organization Content Prototype
- Destroy Organization Content Prototype
- Mixed Content
- Attachments
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Introduction
- Documents
- Resource Types
- Resources
- Alerts
- Alert Templates
- Push App Tokens
- Revenue Reporting
- ABM Links
- Issues
- Articles
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
List Reporting Periods
Pending
GET
https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods
API Permit:Operations:Api:Users:RevenueReports:List
API Context:Loyalty Club
Authorizations:User
Response Body#
| Key | Type | Description |
|---|---|---|
periods | Period[] | List of the periods` within the selected period |
Period model#
| Key | Type | Description |
|---|---|---|
unit | enum: ["day", "week", "month", "quarter] | Reporting period of the policy the report has been made for |
year | integer | Reporting period year |
number | integer | No. of period in the year. Example: 8th month, 31st week of the year |
starts_at | datetime | |
ends_at | datetime | |
deadline_at | datetime | Time at which the reports are expected to be filled by tenant |
policy_id | integer | ID of policy |
completed | boolean | Have all reports within given period have been filled by tenant? |
current | boolean |
Example#
{
"periods": [
{
"unit": "week",
"number": 31,
"year": 2021,
"name": "Week 31",
"policy_id": 32,
"starts_at": "2021-08-01T22:00:00.000Z",
"ends_at": "2021-08-08T21:59:59.999Z",
"deadline_at": "2021-08-09T21:59:59.999Z",
"completed": false,
"current": true
},
{
"unit": "week",
"number": 30,
"year": 2021,
"name": "Week 30",
"policy_id": 43,
"starts_at": "2021-07-25T22:00:00.000Z",
"ends_at": "2021-08-01T21:59:59.999Z",
"deadline_at": "2021-08-02T21:59:59.999Z",
"completed": true,
"current": false
}
// (...)
]
}Request
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Store-Id
integerÂ
required
Default:
{{STORE_ID}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Store-Id;'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2024-07-22 08:30:54